SDK API

API dùng cho việc gửi các sự kiện của người dùng tới Gobysend và kích hoạt các workflow tương ứng.

Để sử dụng được các API này, đối tác cần đăng ký tên miền website với Gobysend và sẽ được cung cấp một mã định danh duy nhất của website trên hệ thống của Gobysend. Các request từ đối tác đều phải đính kèm mã định danh này.

POSTIdentity

https://api.gobysend.com/api/tracking/identify-subscriber

Api định danh người dùng

Khi người dùng trên website của đối tác đăng nhập vào hệ thống hoặc để lại thông tin liên hệ, đối tác gọi đến API này để xác định người dùng tương ứng trên Gobysend. Nếu chưa tồn tại, người dùng sẽ được tạo mới trên hệ thống Gobysend.

API trả về subscriber_id là định danh của người dùng trên hệ thống Gobysend và được sử dụng trong tất cả các event được gọi sau đó. Nếu không có subscriber_id các event gọi sẽ không được chấp nhận.

Một người dùng được định danh qua 1 trong 2 trường:

email: email của người dùng

phone_number: số điện thoại

Vì thế để xác định được người dùng thì bắt buộc gửi lên 1 trong 2 trường trên

HEADERS

Referer

https://example.com

Bodyraw (json)

json

{
    "website_uuid": "(bắt buộc) website uuid được Gobysend cung cấp",
    "email": "example@gmail.com",
    "phone_number": "0987456321",
    "device": {
        "device_type": "android|ios (bắt buộc)",
        "device_token": "//device token id (bắt buộc)",
        "app_id": "//onesignal app id (bắt buộc)",
        "provider": "onesignal (bắt buộc)",
        "device_manufacture": "",
        "device_model": "",
        "device_os": "",
        "device_os_version": ""
    }
}

Example Request

curl

curl --location 'https://api.gobysend.com/api/tracking/identify-subscriber' \
--header 'Referer: https://example.com' \
--data-raw '{
    "website_uuid": "(bắt buộc) website uuid được Gobysend cung cấp",
    "email": "example@gmail.com",
    "phone_number": "0987456321",
    "device": {
        "device_type": "android|ios (bắt buộc)",
        "device_token": "//device token id (bắt buộc)",
        "app_id": "//onesignal app id (bắt buộc)",
        "provider": "onesignal (bắt buộc)",
        "device_manufacture": "",
        "device_model": "",
        "device_os": "",
        "device_os_version": ""
    }
}'

Example Response

json

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": 625993
  }
}

POSTEvent

https://api.gobysend.com/api/tracking/event

API sự kiện

Khi người dùng phát sinh sự kiện (đặt hàng, thanh toán,...) hệ thống đối tác gọi tới API để ghi nhận sự kiện lên hệ thống Gobysend.

API gồm các tham số

Tham số	Giải thích
website_uuid	Website uuid do Gobysend cung
subscriber_id	Id của người dùng trên hệ thống Gobysend, ID này được trả về sau khi gọi API identity
url	Đường dẫn trang người dùng phát sinh sự kiện
name	Tên sự kiện
data	dữ liệu của sự kiện

Do cần subscriber_id nên bắt buộc phải gọi api identity trước khi gọi api sự kiện

HEADERS

Referer

https://example.com

Bodyraw (json)

json

{
  "website_uuid": "(bắt buộc) website uuid được Gobysend cung cấp",
  "subscriber_id": "Id của người dùng trên hệ thống Gobysend",
  "url": "http://example.com/home",
  "name": "last_login",
  "data": {
      "timestamp": 1639543471
  }
}

Example Request

curl

curl --location 'https://api.gobysend.com/api/tracking/event' \
--header 'Referer: https://example.com' \
--data '{
  "website_uuid": "(bắt buộc) website uuid được Gobysend cung cấp",
  "subscriber_id": "Id của người dùng trên hệ thống Gobysend",
  "url": "http://example.com/home",
  "name": "last_login",
  "data": {
      "timestamp": 1639543471
  }
}'

Example Response

json

{
  "code": 200,
  "message": "Success"
}