Hướng dẫn
Xác thực
API key, môi trường, giới hạn request và IP được phép.
Mọi request gửi API key trong header Authorization với tiền tố ApiKey:
Authorization: ApiKey gc_test_4f1c...Key và môi trường
| Tiền tố | Môi trường |
|---|---|
gc_test_ | Sandbox (api-stag.gocheap.vn) |
gc_live_ | Production |
- Mỗi đối tác có thể có nhiều key, ví dụ một key cho mỗi hệ thống. Key thu hồi riêng được.
- GOCheap chỉ lưu bản băm của key nên không thể xem lại key. Mất key thì báo GOCheap thu hồi và cấp key mới.
- Chỉ dùng key ở máy chủ của bạn. Không đặt key trong app di động, trình duyệt hay mã nguồn công khai.
Giới hạn request
Mặc định 60 request mỗi phút cho mỗi key. Vượt giới hạn nhận 429 rate_limited kèm header Retry-After (số giây cần chờ).
HTTP/1.1 429 Too Many Requests
Retry-After: 27Theo dõi chuyến bằng webhook thay vì gọi lặp lại để không chạm giới hạn.
IP được phép
Có thể đăng ký danh sách IP máy chủ được phép gọi API. Request từ IP khác nhận 401 invalid_api_key.
Lỗi xác thực
{ "success": false, "error": { "code": "invalid_api_key", "message": "API key không hợp lệ" } }Nguyên nhân thường gặp: thiếu tiền tố ApiKey, dùng key sandbox trên production (hoặc ngược lại), key đã bị thu hồi, tài khoản đối tác đang tạm dừng.