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
  3. Report người giới thiệu và người được giới thiệu

Lấy danh sách members

Lấy danh sách members theo thời gian hoặc mã người giới thiệu

Base URL:

http://<host-name>/api/v2/members

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

Description

identifier_id

string

Yes

ID người giới thiệu (ID member)

page

String

Yes

Trang hiện tại theo phân trang

page_size

string

No

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

from_time

dateTime

Yes

Từ ngày tạo member, định dạng yyyy-MM-dd HH:mm:ss

to_time

datetime

Yes

Đến ngày tạo member, định dạng yyyy-MM-dd HH:mm:ss

referring_id

string

No

ID người giới thiệu thứ cấp

campaign_id

Array

No

Các ID chiến dịch người giới thiệu tham gia

Example Request

https://<host-name>/api/v1/members?identifier_id=0000000030&page=1&page_size=20&from_time=2020-08-01%2000%3A00%3A00&to_time=2020-08-20%2000%3A00%3A00&campaign_id=336,9

Response

{
    "status": "success",
    "data": "eyJpdiI6ImNQeWV0eWpPYzVVMVFnd2JCYmlDYkE9PSIsInZhbHVlIjoiVExrRDhyOGxIdDdvT2xaWGJ2RXVONWovOFQxeWtyVVk4ZWFyd1BZa3R4cTRTVWZpYnlzUVgzNGxSTEhxZnc2QTZabWdoWThyejBBc2E5Wnc4MkVEWHNjOHF4M0RrU29GbWtQNHRRL3hlYlE1elFIdnVza2E1bFBsVkJGNWR4cHY2dEplN3phS2RBNTRjT2NhTXlCQUFaamVMdDR6TlZMTUxDL1lqb0lzTFFGbms1MnVSOE9SWlp0T3BaTHVrK2tYWWx0ZHd3djgrVEhoTEt1bVdMMWdmdHlSTjQxZFZEK1gwQVhpeTRFQ2dBcmZZcDFwLzZRYks4RnBxaXRIUmlXbXQ0ZVQ1dk04Y2V6TnIxMFIrcU9DYjdZRjRIS09uZk8wcmY0NVd2bkIwb3ZUdllNZXd3NDJiam5yQm92cEtiWExHc0o3NzhDMi9rc2N4U1ppcWVqejJzVU9sNWxyUUtyWW1TaDJVcE9OSVNSRmlUYStEa3lJaEg0N25Db2tuTVByemNvSEpOSmR4U0JIaVlFUFpuK2s3K04zUFJsTFplVllXMmR5RVQ5Q1FrZ3Y4SkVWSndLalBUSEY2d096ZXZhSDdmOFc2QUxYd0VHZFM5RWFxVnNvUnJCNVVNdUFOR3ZvNEpiSmliS3ViZDFkK0g5YkNWTmdpTGY4bGVFTWJOeUY3b2FNeG1NQytwbytRanpFV0RlQ2dINkNJTlVuWE1HOFNRR1A5QndDTm9rSHV1SkdwRXpiZWFvRVRnL3VlWUY3N2NLMTJyY3dlNmdPRTVPcnViZTRCVVdoTGxqTWdwVHVIZ0d0TklsMzNFSGsrQlpVUGYrVjErVFc2SUJlM3RuaW1UK1B6dmVRcDNrN3NTNW5yMFBTQWl2SDRMKzc3WTY3SXR6SmI0L3JvdkoyUjNsUGNQVGVMSVpPeUdZVmY2UXFVcmx4bktkV1BVMm5uYzliWEtzV0pkLzBhb1NJdVdtY0RDTlFMSFlIYjdrTUxyODZOTENGU05yb3VFZXg0Q3pha0ttdEZ2SVJyOVRkUEY4UjYzK2xQdGNud0pBb2U1R0E4bjQzWmFPbis2RHl2ZWVlUm9FOUdCazQva2gxbXBmd2RHOUR0YWl0a2k3RWlpYVNNZDBvQitpQ2xPSC9Ed3I5RERjN0lUMVJNdDVITGIwSXZnNGpocDhHY1R4QVNGdEl3Rms1S2tnSnA4bThvWUxUUCs5ckxYdnZhQmZESjlSclBDTmZQZ2pIcFdsSi9ZMEl4ckxIN2NNVmpqUVpJc1JnUFdsdnBuNytOMXpSK2hrWnVSQ3daTGxqTVdkQjRiWUdkeFVrWTVjcmlqbnpLUHRuVFVLWHhybFRhVDRMV1c4TVloczJDWmlWUHUwWXNFT0JWNEV6QlNkL08rNkIrWXltMlNIMzduWmJuOVFMaXBuVExQa1o3eldkRkdYRG1UeU4rNDdGclpLankzeU5MeW1PU3ByOHFyMkQrMXZiY3BaUk91eFk0ckFTeWxuNjdBYis2NUVTVG5CU0ZtVEV4TXJZNFlLcWhVNkw0dSs1RCtUNkw2MDluOU9SVWV0ZTZocHBTb2ozQi9XbUlrWmZiQkV1OXRIL055RUw0NGlpTGswdDFGYlFtV0xJUGp4MmNQYzlhRWNDb2dMQStQWWdEMzdKaDRCRjlPTElLVkxvYzM0T2ZJdEx2cHRWdUQwRXZPMjZpTW5TSjZYakVOdXVUejhWbkVKUEphaFZQT1V1U2l0cFhNbVpkblRyMW1OR1JncUd1UFZaV1orcTJTR1FVSjNydWFTVndUUXQyV050MnlyejBQcDREMHV1WEFrbXpYZkVMQjlXZ2laaU9BMHJvRDc5UjNSYW5LTWd1N1dUY2RSTFVsN1lyZFYxTGs5K3FTY0RCSnhVdWlyNnk0UzhHa0M0MGFhL0tWNWhHdmtsQTJ3aXgvM0xHMzFYcFNGcHlqRkpEU2htZzFrRU9aTnA4Q1E2L1FtVTkvcWtkSUNoMWdDbWtOTnJGYXdqMUo1VVhsa084dkdSNkU2TmtwVlhzbzY1ak9DN3lzcWtibVh4VVFiR2dyeDk5MHZ3c3hPcmVxRmo2Z0g5dzBBM2pVMU1pY1BRdDNxQTJ1VG8wWlpQL2syM3Y2MzlLcUxYVWE1dU9Bc0Jmb2lYZVQ5amdmalNKRzgwYUUvRkxudDMvNnhhY0Jpb0VZYWQ4TXV3eDR2bzVVdStxZ1JpS05RZG9xV1ZlNXpEN0JRejdnT0pCQnN3SXNyU2tRS25mTCtxaTlyOW1nMU5GOXZjMk14K1l2YkpDclZkcWI0cXZmcXZlaEFLKzF3TWxNNGNhT3hGMnZqdk02SE1MY21rQVI2bTF2RXJZZU93c1hqYUZNTzZhcENOcHVoWkNxMisvQnQwWHlRRW1qemxWM3duTnpFaWVORXpHK1R2RmViVHpBRytMcEJhSVVGTnBoSTlmMzNaOWQra3hlcWVUTmNqL1N2T1B2S3h6QW0yQkx1c2pUOEhyQUhjbTdMNDdLWThOaUFyMXZXZitidlIrNllLQmYzM0ZpWCtQcWNRaFY3ZVpweGxieTBOZ1RHeUFkNnpJMzE4YkowRGxyL2hqMDFwTTZqV3l1dWpBK1RFMWVKd0JTcEh0WVBpdDZGRkI4UEZGN0JJZk90NjdMS1FJWGRHNmlrWVA1MFNWNWNSWlZjSWtlU1EzczREbnRtVFBFVlNHVHJDb21HMitPNE5XcGdqUGxMUlBZbjh6bm4vUVVTampzSXZGS1M4NlY0cFNOQkYweSsvR3UxdDh0U2gyUDljblRwVUs1VXQrUWh4b2pHWkQ4WldKK1RFSnNFWVJGN3MvZz09IiwibWFjIjoiZmVlMDc4YWRmM2M5NWFjYjgzZjY1Yjg0MmIzZTJkZmEwNWY4NGYyMTYzODIwZWM4NGRmMDZiY2EyOGE0MDMzMiJ9"
}

Data sau giải mã

{
        "members": [
            {
                "id": 30043,
                "sso_id": 49063,
                "level_id": 1,
                "username": "7ce7ea6a18e6a42b402526e0813d6c6b",
                "email": "username30@case.vn",
                "created_at": "2020-07-08 11:39:47",
                "avatar": null,
                "facebook_id": null,
                "google_id": null,
                "identifier_id": "0000000030",
                "profile": {
                    "first_name": "username30",
                    "last_name": "N/A",
                    "gender": 2,
                    "phone_number": "0000000000",
                    "status": 1,
                    "position": null,
                    "address": null,
                    "date_of_birth": "1990-01-01",
                    "description": null,
                    "model": null
                },
                "roles": [
                    {
                        "id": 3,
                        "name": "PUB_PUBLISHER",
                        "guard_name": "api",
                        "created_at": "2019-09-13 09:58:16",
                        "updated_at": "2019-09-13 09:58:16",
                        "pivot": {
                            "model_id": 30043,
                            "role_id": 3,
                            "model_type": "Isvn\\User\\Entities\\User"
                        }
                    }
                ],
                "user_types": [
                    {
                        "id": 3,
                        "name": "PUBLISHER"
                    }
                ],
                "permissions": [],
                "referring_id": "0000000026",
                "total_commission_referral": 0,
                "referral_count": 1,
                "referral_total": 1,
                "referral_list": [],
                "campaign_events": [
                   {
                       "campaign_id": "366",
                       "events": [
                           {
                               "conversion_id": "5f2bb8c86c906f5cc089ada0",
                               "event_code": "ACTIVE",
                               "status": "pending",
                               "commission": 0,
                               "created_time": "2020-08-06T15:01:12+0700"
                           }
                       ]
                   }
               ],
	"referral": {
               "ACTIVE": 1,
               "FIRST_LOGIN": 0,
               "FIRST_TRANSACTION_30D": 0
           }
 
 
            },
      ],
      "meta": {
            "total": 1,
            "per_page": "1",
            "current_page": 1,
            "last_page": 1
      }
}

Diễn giải

param

Diễn giải

identifier_id

Mã định danh của user

referring_id

identifier_id của người giới thiệu user

referral.ACTIVE

số lượng member được user giới thiệu ở event active

referral.FIRST_LOGIN

số lượng member được user giới thiệu ở event FIRST_LOGIN

referral.FIRST_TRANSACTION_30D

số lượng member được user giới thiệu ở event FIRST_TRANSACTION_30D

referral_total

Tổng số member được user giới thiệu

event_histories

các event của user đạt được

event_histories.conversion_id

id của conversion tương ứng với event đạt được

event_histories.event_code

tên event

event_histories.status

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

event_histories.commission

Hoa hồng cho user khi giới thiệu được member

event_histories.created_time

Thời gian event được tạo

PreviousReport người giới thiệu và người được giới thiệuNextChi tiết thông tin member

Last updated 4 years ago

Was this helpful?