Chuyển tới nội dung chính
ZZalo Platforms

Thông tin cấu hình

Để gửi yêu cầu đến hệ thống Transfer Service, vui lòng làm theo hướng dẫn sau.

Định dạng URL​

Tất cả các truy vấn đến Transfer Service phải được thực hiện qua giao thức HTTPS và có định dạng như sau:

https://api-transfer.zaloplatforms.com/api/v1/<api>

Ví dụ:

https://api-transfer.zaloplatforms.com/api/v1/order/query

Phương thức HTTP hỗ trợ​

  • GET
  • POST

Cách truyền tham số​

Transfer Service hỗ trợ API với các cách để truyền tham số như sau:

  • application/json : Gửi dữ liệu dạng JSON-object

Phản hồi từ API​

Phản hồi từ Transfer Service luôn là dạng JSON-object, gồm các trường thông tin chính sau:

TrườngÝ nghĩa
error_codeMã kết quả: 0 = thành công, giá trị âm = mã lỗi nghiệp vụ (xem Bảng mã lỗi)
error_messageThông báo mô tả kết quả hoặc lỗi (tiếng Việt, ví dụ: "Thành công")
dataĐối tượng dữ liệu trả về khi thành công; không có hoặc null khi lỗi

Ví dụ response thành công:

{
  "error_code": 0,
  "error_message": "Thành công",
  "data": {}
}

Ví dụ response lỗi:

{
  "error_code": -501,
  "error_message": "Invalid application id"
}

Lưu ý​

  • Request body cần gửi đúng Content-Type: application/json.
  • Các API đều yêu cầu xác thực bằng chữ ký (signature); tham khảo hướng dẫn từ đội kỹ thuật hoặc tài liệu Authorize khi được cung cấp.