Sử dụng

Cấu hình

Sử dụng api_key được cung cấp và cấu hình như sau:

export API_KEY=<api_key>
export API_HOST=<base_url>

Hướng dẫn sử dụng các lệnh export và curl được cung cấp sẵn khi chạy bằng terminal trên hệ điều hành Linux hoặc Mac. Trong trường hợp bạn sử dụng môi trường khác, vui lòng thay thế bằng các thao tác tương đương.

Cấu trúc API

Request

Một lời gọi API tiêu biểu như sau:

curl $BASE_URL.Misc/CurrentAccount \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{}'

Tất cả request sử dụng giao thức HTTPS, method POST và truyền giá trị bằng body sử dụng định dạng dữ liệu application/json. Các header bắt buộc là Content-Type và Authorization.

Response

Response sử dụng định dạng dữ liệu application/json được set trong header Content-Type. Nếu request thành công, HTTP status code là 200. Nếu request lỗi, HTTP status code có thể là 4xx hoặc 5xx với cấu trúc tương tự như sau:

{
  "code": "invalid_argument",
  "msg": "..."
}

Các lỗi thường gặp

400 Bad Request

{
  "code": "invalid_argument",
  "msg": "..."
}

Vui lòng kiểm tra lại các giá trị cung cấp.

401 Unauthorized

{
  "code": "unauthenticated",
  "msg": "..."
}

Vui lòng kiểm tra lại request đã bao gồm header Authorization: <api_key> đúng.

404 Not Found

{
    "code": "bad_route",
    "msg": "unexpected Content-Type: \"\""
}

Vui lòng kiểm tra lại path và header Content-Type: application/json.