Bắt đầu

Lỗi

Khi có lỗi, API trả về mã trạng thái HTTP tương ứng và phần thân chứa code và message bên trong error.

Hãy dùng code trong chương trình của bạn. message là văn bản tiếng Anh giúp người gỡ lỗi và có thể thay đổi.

Định dạng lỗi404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

Thiếu khóa401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Mã lỗi

Trạng thái	Mã	Khi nào xảy ra
400	`key_in_query`	Khóa được gửi trong URL (tham số `api_key`, `apikey`, `key` hoặc `token`). Hãy gửi khóa trong header và tạo khóa mới, vì khóa cũ có thể đã bị ghi lại trong log.
400	`invalid_parameter`	Một tham số có giá trị không hợp lệ, ví dụ `per_page` vượt quá mức tối đa.
401	`missing_api_key`	Yêu cầu không kèm khóa.
401	`invalid_api_key`	Khóa không tồn tại, đã bị thu hồi hoặc người dùng của khóa đã bị vô hiệu hóa.
404	`not_found`	Endpoint không tồn tại, hoặc mục không tồn tại hay thuộc một tổ chức mà người dùng không được xem.
404	`organization_not_found`	Giá trị `organization` được truyền không phải là tổ chức mà người dùng được xem loại mục này.
405	`method_not_allowed`	API chỉ chấp nhận `GET` (và `HEAD`).
429	`rate_limited`	Đã chạm giới hạn yêu cầu. Hãy chờ số giây trong `Retry-After`.
500	`server_error`	Lỗi nội bộ. Hãy thử lại sau giây lát; nếu vẫn lỗi, hãy liên hệ bộ phận hỗ trợ.

Chỉ nên gửi lại cùng một yêu cầu sau lỗi 429 (chờ hết Retry-After) hoặc 500. Các lỗi khác cần sửa yêu cầu hoặc khóa.