Scalef Developer
  • Hướng dẫn sử dụng tài liệu
  • Hướng dẫn tích hợp chiến dịch
    • Tích hợp ghi nhận đơn hàng từ Website
      • Mục đích và cách hoạt động
      • Postback tạo đơn hàng
      • Tích hợp qua Java Script
      • API tạo và cập nhật đơn hàng
        • Create conversion không có thông tin sản phẩm
        • Create conversion
        • Update status conversion
    • Tích hợp qua các nền tảng Website Builder phổ biến
      • Haravan
      • WordPress
    • Tích hợp các CRM phổ biến để tạo và theo dõi đơn hàng
      • Hubspot
      • PushSale
    • Tích hợp ghi nhận đơn hàng từ App
      • Firebase
      • Appsflyer
  • Cách thức cập nhật đơn hàng tự động
  • Tích hợp hệ thống trang của Publisher - API backend
    • Publisher API
      • Sử dụng script chèn vào landing page
      • API get notifications
      • Sign firebase token push notification
      • API Get conversions by publisher
      • API Join campaigns with array campaign id
      • API report publisher
      • API get top publisher
      • Create order by Publisher
      • Authentication
      • Danh sách Campaigns và chi tiết
      • Khởi tạo referral link
      • GET click detail
      • API cho chương trình thành viên giới thiệu thành viên (MGM)
      • Report người giới thiệu và người được giới thiệu
        • Lấy danh sách members
        • Chi tiết thông tin member
        • Lấy danh sách Top members
      • Report thông tin chuyển đổi và hoa hồng
      • Thanh toán hoa hồng cho người giới thiệu
Powered by GitBook
On this page

Was this helpful?

  1. Tích hợp hệ thống trang của Publisher - API backend
  2. Publisher API

Report thông tin chuyển đổi và hoa hồng

Base URL:

http://<host-name>/api/v2/publisher/conversion

Header:

X-Network-Id  :  2
X-Port-Type   :  PUB
Content-Type  :  application/x-www-form-urlencoded
Authorization :	Bearer {access_token}

Params Request

Param Name

Data Type

Required? (Y/N)

Description

identifier_id

String

Y

ID người giới thiệu (ID member của OCB)

campaign_id

String

N

ID của chiến dịch / chương trình

order_id

String

N

ID của order

page

Number

Y

Trang hiện tại

page_size

Number

N

Số lượng kết quả trả về / 1 trang, mặc định là 20

click_id

String

N

ID của click

status

String

N

Trạng thái chuyển đổi: pending, pre_approved, approved, rejected, hold

from_time

DateTime

Y

Từ ngày phát sinh chuyển đổi, định dạng yyyy-MM-dd HH:mm:ss

to_time

DateTime

Y

Đến ngày phát sinh chuyển đổi, định dạng yyyy-MM-dd HH:mm:ss

Response:

{
   "status":"success",
   "data": "eyJpdiI6ImwxS1pERkVpNlNWcS9vbHh1ZkxGa2c9PSIsInZhbHVlIjoib3dVZ2d3RkxBZEwyOWdQWWZ1cFM5TTNWOUQxOHFIL1hFVDBML3ZzZVhKY014SXJvbFBzaWhHWEFkbk1oREdIUGJBeDM5UGtQUUZUT1VVNHkrRHlvYk94Z2l0Mzk5T1kwdURHQ2dJUDBiNk1uNjc4ZEVrOTZ1SWhNckhFRlRVczJpcWlWMzFZb01tZkhkYnZiVUNxOWUrSDBMemRKNExBU1UyQ0RsM1NwR0NzdFV4UHY1eEdRbjF2TWdheFRtUHZOWjY4NUIzTk1jNWo3VzJkMitSS1JFVFg4RXgxTUduRDdpb2lGOFpxNWUxeVNhV0VOcHFoYXh4MGRwOVlLRFo2UDhiTENRUjJwZmF4TmxvMS9HTTlFYytuMmJ0VVNQZ1UrWWxvejU5VWxWa2gyN2w5Mjg3cnRZTG0yNzRPd2I0d2dLblhGUncrTU1WTjFCZ0E4b2pabXg1M0UrYUM3OXY1WVdZQzhpenB1K0hvMm1BL2xmSVlqRmZlVzZ5djM1dk1lV2JndU5LZmxUS0JKM21pSVJGNzBNTEFzZVlXa3lJd1BTbXhVTkcxSlRKWXpkRmRxVyt0V1dLSTRhWkpxT1B5cXRnd3dtbDBJazFsdzFTR29nZU5KVHQxb1hCcHR1VldxbVRwaVRWbHo4cXZGOVVkdHA1Y05DZmxCdXFwTlM5c2hpajNIdjMya1VOZklPL0xsRjFFbWErSVhnUFdVU1pmWkt3YUxTME84Um16MkorVDBrZWdXNVgxVEhoNHl6cFYxc1pVRUwzUmVhUVJ1ME0vL1JwWFZBaXI3NlIzUy93WUNucDlXbkF1OFRDVW5qL1ZtOWxSWFBEcStOc0xvYWUyQlltVkpHWDN6SkRZYmNnenVPQ3FFTnBrcFZPcXAySmV2UUJCaUV0L1oycmhBRE5CTWdpYWpzOFdNZ1pRS091a2pFcUJkYXFMeGlCWFVNTE5zNllTVUR6UHpLTnMyVU9OM0RyakJoV3RJeVBVcjhDSDBmR0xZcTR6cHNvMGFueUJKNFB4RXI1dWJ6OEtDU3JyR3RKTDJ6VUNIbzYyakN4dzRMUE1EUWNwVjZxUFFCVzhQYnpIaGV2anNhV2hRQkRPY2dRQ24veU03bGZ1VVB3dWZyMHA0S2Nma290MW1HSWV3L1hUcFkrekYvTW9idGpkckhDSFM0STZWOUZyVlNwTFBmYXFsN1Rzc3ZDQUxMZnVUYUZNLzFLaE9veHNnYitJZTR4eTJQZVB1NGNmZU0rRWxNQlgzR2dObjFCY3RON3V3Y01RakR0eDRxaFdiTHJ5a01YeXQ4cGNnWFpwOFczRnc2RndjZ2dyYWgrSlI3M1VMdnk1U2VEMHQ3N0UxYTdtT3Z4aTJIMEpBbDdoOVR3RC9JZnJ5cW5hSElDbGdJN3JKMUtaNmI1eDAybDcxQWR6QVJzalA1Uk9iaTd4MzNRZUpqV1JZTDJtTkxUcTVydTNTWXdGU0YwNkQ4ZWtEc2MxZE1EdzJ3M3NFYWU1MDBxejRpTGZCeVJHR2FPaXVOc3p3V09SMm5KYlVmM1lramtvcVJkNGVFY0RKOTlJdWsyYkNFeXZEYm9iK1pSdmpLc3k3UEMzNnNISXZnOVN1VktRbitTbElqQ3JBRE0zeElMaTFMWldJeS84SWQ4dzZmTU1mRlByaGRRY0xaZFYvM2RRWXhmTkJmUzRub2dIRGhpS1RDUXo1YWhTc2ZGbUwzK0I5SEh0a2xHRS85ZUNUZHl4Q3Zxa0lNdVJnRG15QzJLdVo4K1U2RVF6QTVhYWh5czV3S1BsbnNzU3h3a1lHdW1GMFFmZzN0U3V3M0NPQUdYd3pMNTZMbGlRa0lJeHJQZ2NBR0JIK0VkU1ZpK0hMcldZL0VSL2dLUzZ3U3hIM0NjTDU5VEJFUU9aTzJ3eFRUQy9Cem9uSXdpaDBabUdHR3V6ZE9kNWFvNDF3cnhMKzg1bmVPL1BSS1hrRFM1K1ZJdXJYYm1wVnd4bWFZV3ZWWnptMlY2bjNNTWc3TWlyV096ckppcFRTYVZlaVZzUTc1Tm5paEs3bUFIOC9kN08rTm0wY2IxVFFQR3JyUnowczFHcElLMm9IMFgzditWc0toTFBmd29ERDhTb1o0a2xWRzFyWjBaRFFJdHhoclJrTVBDcDlsbEhqb2p5eDVldHcwYkUreHVRVDQwSnRYbWIwZ0JWZG1TR2JYVHRhWThINGhOSHhrdWs2VHMvVHV3dkFKdXJYdFF0bUV6b2xGZjZYWVlqL3NxRHZKUDN1ZHJVSDRFWnQ5aXJjTUFUUGJZa2NraXd1RFJDUzhtUzR2K1NQOGxraVlBQjF2N3lvalk1VXVBdkVhcDNpVEFVR0kvS0RGNVBwMDVjU3lsbHozQmx6em1pRXk0ZzU0dE1UQkVKRlcwU3NPUEJ2Z1BHbTFrUVBXL0pOZjdBUHpUdktHRE9GNXNyNXkxeGYydGluMHdVVEZKMmR5TEpwcjRyOGo3bTRBV25aYVo1WjVVQ2ZiTkN2YUE2RWV2Y0JGWGxmSTJmS1JsZXQrbkZIUG1EMndqcHp4UHFtUUVQZnUrNmNQQ3MwNVU4TGVYRm9JNGZMblZqMlBTNEVVTE5vZlJKRjBxQUU1SzFGNzR2ZG9ONDR6ak5nMlBqbzBVSG5kRHVLZHVpRjVEdHlyVm43bHJZWjhFQVE1WTJ1bldDRkh0TFkyUEMwR1luaThUTkFjb1hRN1IzbXg3RUZ3MFE0MnZibGhnekZnbXhmRWMwa21pdmZuMmRWRUk2YVRDdnNMZmgxRFY3WmFwMkpFaXBPaE1rOXlkS3hjOHQxcWFIYnIzOFdhU0dJNk8rSlZSWFJXZ251L3hPdW5oa2pvaWwxYktEeStPd1VkZDV3RnFZVHZ6ZzgrdHRXNEZTOGVjcEo0bHdiQm02MS9zazhmd09jL2h5WkRBRHF5NytlcWx1b3ZkNzgyOXM0ZWx6R05KOUNzbTBDZ0Jwa1hJYnpZN2RKbUV1NGNnSlV1b0VPa1FJaHpkeGZ4NHN2WGZ6L25MdkEvZi9pS01Md09Ha25xZjgwcFZYMmgzUkZSVm5WSGJZWkJJTStvckZ3SzREN2VmYSt0UTBtMFhCUlc2bHA3c0NsSjM1Sk1vMVJmZCs0a3JCQXpQQ1g3NStuNHlWZGZna3ZwQ3ZCUXVPOEs1MkNBd0ZhZVljMWxCOGF3OXlSd3JMdWxDak84T2dlWi91SW9OcnJVeXYzWCtPVnpOQkprS1BoVXRNcExud2EvUEV2YTNmREorRmFhdE9jLytvWG5BcUlWOVRjY29YTmRYYlZuL2NJVGVNb09KY25uaFVjUjZzU05QeUxBcWRlV2xSaGJjOERraEk3Umc2cm0yMnpvd1cwTUFRS1U2OUpQTzF1dlFIOUdjN0YzcGxLVXo1OStDa0lBRGlWWDMzYldnZWVWYVBRNk1XT2FCc25nazJpVitCNWVjTEJ6NTN2eFZLMzY2eUtlT3cwTndlZjBjcGppT0VoVmJIQkQ3Rk13cmp6ckpxTm12VVBNUzdGcXNscEE1VnpZVVBSKzRvdTA5VmdLMDVvRGxBaG9EUUZJSTJtd0FkOGNEVWJtNW1IbFNTSjNMWHEzaHRXZ3RoMWZvN1ZJa3V6SlpHbEYvdUlzay9CNGNydGx3TElkUkU1Uk8xcEtyc3J5djJSTUNDUk13QlB5UlFqSnAzc1QxeU5pbkltMERXNFVlSDQrbkdwcWVINmFXRGdyOW5IeWQrS2hzUEY2YVNVdDRLbjNzcFdCNjkrbkZlUlpWS1ozRW0rRjNWRGMzbythQUpudGZSQktVVGxUaFg1aUF0K0M1cnN3SlVoZTlyOGVHZVNZY1N5M3dQZUEvWU02cmN1blkwV05KdjkxOFRzYzUwTmlVVFk1cjllNnFRWkROc29NbXdaYmJxYW95WjZhZ2F6NUgwVTltQ2l2bTREbmlZU1FId3BzTk5zVjNUZHloRjRIblNZbUhUMFI3WlZaNEczcHBneGU1WVZzRmE4dUNYdXQ1dzVNV3QxaERRQ3p3WjFUZjI1eXlNbzNHcHpOZUtIbXBTYnlIVG1jUy9tWDV2Mlp6b2REZG1NUHFIMmJTWllmZXRTSmNxMExZakQ3SzJuOWpxZzgyZDc5SXh3Q3NzSzd1eWU1Sm5MeDE3MDhGUmEzY2ZXSWViaUFNZ3hMMWNoZGgxMkpmdmtqTVdHS3hDNnFVTU5WVXhlK3BRaGtwWGszY3NSVTkwSFBndVBiemJsNnhsRXZtQ25zS3BZK29iL3llODB1dTdpOVFQRHZucTZrRWc0YjhpRWxwcFFHOFFXRXo4MUprYldTNklsTDZiUElPY1JYOC8wUEx6ZVQyMGhZdWRTU25jcm54cDJGOWNJTHVsdy9LcHQrRStTUHZ0ZjVsSFFORTBrd1dFZ0I4a3B3NlFSQ1BjK0RuNDIvd1REYVpPd3RYZlZ3S0pYVjdTc291VE4zb0NRUUM0TUNLMG1waFg4S0V2ZmZqNEgxeXNXUnVHM3FCTGxkbU9qdWQ0R2E4V045cVlvQ3Jnc3ZRU0xmOFR6Si9aKyttSkdudjZRVUdxZFNLWEpGTGdGUm5SSkxRR1JJaEFTak9MemNJZ2VHYnFnTDBiWGFldXA0dkRVL2FZaW5rNHdSTktZcFB0cnVqVHkrR1ZMY1d0eXZQVnVxWFljbURod3R4bVNiSFdpTkJRdlYxVWdzNy8zTkxlR2FabHdyWFNMS0NPc2NPcm1WV2JtWjg0TGwza3hCU1hRN0UyVzJ6RkFjNWF6MGhHWG9nM2I1NHIzMVgvQXF3VFExUE1Oa0IvdXgyWkJqd2ZyZkU3YWNXV1VyUy93VXRjNzc4RzZRY3YrU2dSZ1lqQWRwT2pJNFRaR1lqeDQxSTBUeEJBV2JIUi9lbTM0TlRMN1JGVjB5N2FjaGRhZDFwT0ZHMktmYlkwM3VKSkQrcEROckFNeEVkMzFyenZYWStPb3N2a0NxMDhJYmM0c0E2eDN6M3ZHaHVOZU5jeUdrRTdGTmtEdUZvOFRudmk5cDVxSTBucXhiNWdNekd1MkhvVXQvV0lKOGc5QUErbStqbWFlR1BJbGR6OTNQM1FkdXR1N3dyS2FPNG5JRkZ6N0tMeHBMelNPU2I4VkdibW1UREFYV0tzOGRXUjNxb1pSNG9MWGJIRStqWGRaMHBHKzE5OWNLWXRwRjJEUURnVFV2UXNBREl0bGhMOVRlUFdaQkdWRk1ZeGVDUHNBdlVUVW5QZzZZbm0wSDlTRzhTQXgvREVvNUhJam9PKzY0RkZoYldFT1ROS1M4SktjSmEvOUxUSWlEdHRjRjB1MGs4SG1HL2JwVWtVdGVNQmlwRHIrdzBic212Vmgrb0hueVQ3UVU0Ri9MTVRYazEzMWp5MkpwL0QydnhsS09YcnFMTnpPbk5xMmsxL2pnY0N1UGE2TXgwT05GeklyK25DSit3ZmU1emRkL2NIYnAyVGppT3NKQm1yK3pDTlJlNjRQbVIvVk9pdGp3L3BFQ0V3WVliQWFnTTUrTkpIR3NVejJmbHhiUnJYOXVSK3RydEs1N2lITEhtSnkzL0FSY21NQWNBdkpUc0tqYzVIY095MTRkdk4vcXFXTjF3aFZBcHUyTG11RFJOQXFhbWp3ZGRYL1RWVEhsOHpFbm1NVzlSdVRDUlJRcVZjaWdNTjcwSm9mWXlwU1M0eHFBYlhONStSd01jZW9Ba2tVN0w2b2xxNVNlemxDTS9NT21mZ1FKaUhRaVRwRVRibzdGNUlENTlNNjNQd0EzaGs4cDdnQTk4bklTV3lZVVJlbWhoaVI4dnRiUk1mSExnPT0iLCJtYWMiOiI5OGNmNWUwM2JjOWI1YmM4OTYyZmVjOTE4ZTc3MTZmNGM2ZjZiMTVkMWIyZjkzZTExZGI5ZmU5YzExNWE3YjRhIn0="
}

Data sau giải mã

{
      "conversions":[
         {
            "conversion_id":"5eccdbfc6c906f1659c422f9",
            "click_id":"e269ae8f11a74deba332e0028b224e6d",
            "campaign_id":"254",
            "campaign_code":"CAM000000254",
            "order_id":"4aba2fa414ab40d093761130178db923",
            "action":"sale",
            "action_time":1590483964129,
            "action_date_time":"2020-05-26T16:06:04+0700",
            "total_discount":{
               "amount":0,
               "currency":"VND"
            },
            "total_sale_amount":{
               "amount":0,
               "currency":"VND"
            },
            "total_commission":{
               "amount":0,
               "currency":"VND"
            },
            "client_ip":"222.252.31.232",
            "user_agent":"PostmanRuntime\/7.25.0",
            "conversion_parts":[
               {
                  "id":"dang_ky_the_OCB_thanh_cong",
                  "sku":"dang_ky_the_OCB_thanh_cong",
                  "url":"http://ocb_omni/register/?clickid=12344455",
                  "price":0,
                  "discount":0,
                  "sale_amount":0,
                  "currency":"VND",
                  "name":"dang_ky_the_OCB_thanh_cong",
                  "category_name":"dang_ky_the_OCB_thanh_cong",
                  "category_id":"dang_ky_the_OCB_thanh_cong",
                  "quantity":1,
                  "commission":{
                     "amount":0,
                     "currency":"VND"
                  },
                  "calculate_by":"FIXED"
               }
            ],
            "status":"pre_approved",
            "reason":[               
               {
                  "log_time":"2020-05-26T16:36:05+0700",
                  "log_action":"edit[Conversion_Info by mp_api_d2c]",
                  "log_message":"g\u1ecdi l\u1ea7n 1 => b\u1eadn, thu\u00ea bao, kh\u00f4ng nghe m\u00e1y => g\u1ecdi l\u1ea7n 2 sau 60 ph\u00fat"
               },
               {
                  "log_time":"2020-05-26T17:36:17+0700",
                  "log_action":"edit[Conversion_Info by mp_api_d2c]",
                  "log_message":"g\u1ecdi l\u1ea7n 2"
               }
            ],
            "created_time":"2020-05-26T16:06:04+0700",
            "updated_time":"2020-05-26T17:36:40+0700",
            "identifier_id":"6477853091020073",
            "click_detail":{
               "click_id":"e269ae8f11a74deba332e0028b224e6d",
               "publisher_id":"9",
               "publisher_name":"4021ece215fc3d9f69a3f9b99fb740cf",
               "ad_space_code":"ADS000000002",
               "contract_no":"CON000000001",
               "advertiser_name":"ocb_omni",
               "campaign_name":"OCB OMNI",
               "campaign_id":"254",
               "campaign_code":"CAM000000254",
               "campaign_domain":"test23232.vn",
               "client":{
                  "clientId":"0dfc3afc463a80606ef988839d762c46",
                  "clientIp":"222.252.31.232",
                  "clientTimeZone":"GMT+07:00",
                  "clientLang":"vi",
                  "userAgent":"PostmanRuntime\/7.25.0",
                  "deviceModel":"Other",
                  "deviceFamily":"Unknown",
                  "deviceBrand":"unknown",
                  "deviceType":"Desktop",
                  "deviceName":"Unknown",
                  "deviceOs":"Unknown",
                  "deviceBrowserId":"16843022",
                  "deviceBrowserName":"Unknown",
                  "deviceBrowserVersion":null,
                  "location":"VN",
                  "mobileDevice":false,
                  "desktopDevice":true,
                  "tabletDevice":false
               },
               "click_uri":"Local API",
               "referer_uri":"#",
               "origin_uri":null,
               "target_uri":"#",
               "status":null,
               "version":"v1",
               "click_time":"2020-05-26T16:06:03+0700"
            },
            "cal_commission":{
               "total_cal_commission":{
                  "amount":0,
                  "currency":"VND"
               },
               "total_cal_commission_pub":{
                  "amount":0,
                  "currency":"VND"
               },
               "total_cal_commission_at":{
                  "amount":0,
                  "currency":"VND"
               },
               "total_cal_commission_agent":{
                  "amount":0,
                  "currency":"VND"
               },
               "cal_commission_parts":null
            },
            "adv_utm_param":{
               "utm_source":"accessTrade",
               "utm_medium":"CPO",
               "utm_campaign":"CAM000000254",
               "utm_term":"",
               "utm_content":""
            },
            "pub_utm_param":{
               "utm_source":"",
               "utm_medium":"",
               "utm_campaign":"",
               "utm_term":null,
               "utm_content":"",
               "sub":"",
               "sub1":"",
               "sub2":"",
               "sub3":"",
               "sub4":""
            }
         }
      ],
      "meta":{
         "page":1,
         "page_size":20,
         "total":1,
         "total_sale_amount":0,
         "total_pub_commission":0,
         "total_agent_commission":0,
         "total_at_commission":0,
         "total_commission":0,
         "total_conversion_part_quantity":1
      }
}

conversion_id

id của chuyển đổi

click_id

thông tin conversion đến từ click

action_date_time

Ngày tạo ra chuyển đổi

status

Trạng thái của conversion. Trạng thái mặc định khi tạo conversion là pending. Dùng API update status để thay đổi trạng thái

PreviousLấy danh sách Top membersNextThanh toán hoa hồng cho người giới thiệu

Last updated 4 years ago

Was this helpful?