Xác thực SePay API v2 và rate limits

Hướng dẫn xác thực SePay API v2 bằng Bearer token và hiểu các chính sách rate limiting để tránh bị giới hạn trong môi trường production.

||

Xác thực

Mọi request đều yêu cầu Bearer token trong header Authorization.

JSHeader
1
Authorization: Bearer {api_key}
  • API key là chuỗi 64 ký tự alphanumeric
  • Lấy từ Cài đặt công ty > API Keys trên cổng SePay
Thông tin

Xem hướng dẫn tạo API Token tại trang Tạo API Token.


Rate Limiting

  • 3 request/giây mỗi địa chỉ IP
  • Rate Limiting được kiểm tra trước xác thực
  • Vượt giới hạn trả HTTP 429

Response lỗi xác thực

Tình huốngHTTP Statuserror_code
Thiếu header Authorization401unauthorized
Định dạng token không hợp lệ401unauthorized
API key không hợp lệ/bị vô hiệu401unauthorized
Vượt Rate Limiting429rate_limited

Response 401 (Unauthorized)

JSON
1
2
3
4
5
{
"status": "error",
"message": "Missing Authorization header",
"error_code": "unauthorized"
}

Response 429 (Rate limited)

JSON
1
2
3
4
5
{
"status": "error",
"message": "Too many requests",
"error_code": "rate_limited"
}

Response 429 kèm theo các header sau:

HeaderMô tả
Retry-AfterSố giây cần chờ trước khi gửi request tiếp theo
X-RateLimit-LimitRate Limiting tối đa (3)
X-RateLimit-RemainingSố request còn lại (0 khi bị rate limit)
X-RateLimit-ResetSố giây cho đến khi nạp lại token