Giới thiệu 3NS Platform API

Tạo API Key

Vui lòng liên hệ 3NS để được cấp API Key kết nối.

Cách sử dụng

Ở phần header, chúng tôi sẽ sử dụng API Key trong trường Authorization với giá trị như sau: "Bearer [API KEY]" 

Ví dụ

curl --location --request GET 'https://api.3ns.com.vn/platform --header 'Authorization: Bearer [API_KEY]'

API Xem thông tin Platform

URL: https://api.3ns.com.vn/platform/profile
Method: GET
Content Type: application/json
Response Type: application/json

Example request

curl --location --request GET 'https://api.3ns.com.vn/platform/profile' 
--header 'Authorization: Bearer [API_KEY]
--header 'Content-Type: application/json'

Example response

{
    "error": 0,
    "message": "Success",
    "data": {
        "name": "3NS Platform",
        "redirect_url": "https://3ns.com.vn",
        "webhook_url": "https://3ns.com.vn"
    }
}

API Cập nhật thông tin Platform

URL: https://api.3ns.com.vn/platform/profile
Method: POST
Content Type: application/json
Response Type: application/json

Tham số Kiểu dữ liệu Tính bắt buộc Mô tả
redirect_url string yes  
webhook_url string yes  

Example request

curl --location --request POST 'https://api.3ns.com.vn/platform/profile' 
--header 'Authorization: Bearer [API_KEY]
--header 'Content-Type: application/json' 
--data-raw '{
    "redirect_url": "https://3ns.com.vn",
    "webhook_url": "https://3ns.com.vn"
}'

Example response

{
    "error": 0,
    "message": "Success",
    "data": {
        "name": "3NS Platform",
        "redirect_url": "https://3ns.com.vn",
        "webhook_url": "https://3ns.com.vn"
    }
}

API Tạo tài khoản 3NS

API cho phép platform tạo tài khoản trên hệ thống 3NS.

Tạo URL xác thực 3NS

URL để user của platform có thể đăng nhập/đăng ký 3NS, sau đó thực hiện cấp quyền cho platform.

Cấu trúc chung:

https://app.3ns.com.vn/platform/auth?platform_id=[platform_id]&redirect_url=[redirect_url]&state=[state]

 

Tham số Kiểu dữ liệu Tính bắt buộc Mô tả
platform_id
 string yes Mã Platform
redirect_url string yes Redirect URL đã được cài đặt
state string no Thông tin khác

 

API Tạo Token của Client

API cho phép platform tạo Token của Client để sử dụng API https://3ns.com.vn/tai-lieu-ket-noi-api/

URL: https://api.3ns.com.vn/platform/token
Method: POST
Content Type: application/json
Response Type: application/json

Tham số Kiểu dữ liệu Tính bắt buộc Mô tả
code string yes Code của bước kết nối OA ở trên

Example request

curl --location --request POST 'https://api.3ns.com.vn/platform/token' 
--header 'Authorization: Bearer [API_KEY]
--header 'Content-Type: application/json' 
--data-raw '{
    "code": "28fe181b750b3989e350abd3aab51df5a4922370"
}'
Thuộc tính Kiểu dữ liệu Mô tả
error boolean true/false
data string Token của Client
message string Nếu error là true, API sẽ trả về nội dung lỗi

Example response

{
    "error": 0,
    "message": "Success",
    "data": "99|JCXMvBF8v8qrTJG7p0rHaTEdOQlFDXgpYvC3Dz7z"
}

Ghi chú: 

+ Mỗi mã code chỉ dùng được 1 lần, giới hạn 10 phút.

+ Token của Client không giới hạn thời gian. Platform lưu lại để tiện cho việc sử dụng sau này.

Webhook

1.Thay đổi hạn mức gửi ZNS

{
  "event_name": "change_oa_daily_quota",
  "oa_id": "351024912508337XXXX",
  "data": {
    "oa_id": "351024912508337XXXX",
    "prev_value": "500",
    "new_value": "1000"
  }
}

2. Người dùng nhận thông báo ZNS

{
  "event_name": "user_received_message",
  "oa_id": "351024912508337XXXX",
  "data": {
    "message_id": "99d55380-813a-4b69-ba2e-aba04d5fbbb8",
    "user_id": "84912345678",
    "delivery_time": "1602960467432"
  }
}

3. Thay đổi trạng thái của mẫu tin ZNS

{
  "event_name": "change_template_status",
  "oa_id": "351024912508337XXXX",
  "data": {
    "template_id": "123456",
    "prev_value": "PENDING-REVIEW",
    "new_value": "ENABLE"
  }
}