Mục lục tài liệu

Kịch bản 1: Người dùng định danh

Làm mới phiên

Đổi refreshToken lấy cặp token mới khi accessToken sắp hết hạn. Ứng dụng gọi trực tiếp, không cần x-api-key hay token.

POST/auth/refresh
Kịch bản
1: Người dùng định danh
Xác thực
Không cần

Tham số

TênVị tríKiểuBắt buộcMô tả
Content-TypeheaderstringBắt buộcapplication/json
refreshTokenbodystringBắt buộcRefresh token đang lưu.

Cần chú ý

  • Access token mới nằm ở trường token, không phải accessToken.
  • Ghi đè cả token và refreshToken. Refresh token cũ hết hiệu lực ngay.
  • Nên làm mới sớm vài phút trước hạn thay vì chờ lỗi 401.
  • Khi ứng dụng chuyển sang người dùng khác, xoá token đã lưu rồi khởi tạo lại.

Request mẫu

POST /auth/refresh
bash
curl -X POST "$GW/auth/refresh" \
  -H "Content-Type: application/json" \
  -d '{ "refreshToken": "<REFRESH_TOKEN>" }'

Biến $GW, $API_KEY, $ACCESS_TOKEN được giải thích ở trang Xác thực.

Response

Trường trong `data`KiểuMô tả
tokenstringAccess token mới, gửi trong header token.
refreshTokenstringRefresh token mới.
expiresInnumberSố giây còn lại của token.
refreshExpiresInnumberSố giây còn lại của refreshToken.
200 OK
json
{
  "status": true,
  "httpCode": 200,
  "data": {
    "token": "00297d0aa6bf300c85c1431c061113ac0f75c50c9ba7332e6148c98dd553c53e",
    "refreshToken": "8da4dc23a3a81e5333b4d089aa6313cfbf6d3307bcec8b8c3f3b2dd5b9b58808",
    "expiresIn": 86400,
    "refreshExpiresIn": 2592000
  }
}

Mã lỗi

MãÝ nghĩaCách xử lý
httpCode 401refreshToken không hợp lệ hoặc đã hết hạn.Khởi tạo lại qua backend.
Cấu trúc response và lỗi dùng chung