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

Xác thực

QuestLab dùng hai loại thông tin xác thực: api-key cho các lời gọi từ backend của bạn, và token phiên cho các lời gọi từ ứng dụng.

Nhận thông tin kết nối

QuestLab cấp api-key, đăng ký địa chỉ IP backend của bạn, gán phạm vi dự án và gửi địa chỉ gateway cho từng môi trường. Liên hệ để được cấp và tư vấn.

Liên hệ tích hợp

Api key (x-api-key)

  • Dùng cho mọi API /questlab/integration/**: khởi tạo người dùng ở kịch bản 1 và toàn bộ kịch bản 2.
  • Chỉ gửi từ backend có địa chỉ IP đã đăng ký với QuestLab. Không nhúng api-key vào ứng dụng.
  • Luôn gửi kèm transactionId, khoá đối soát do bạn đặt. Thiếu thì nhận 400 (2021).
  • X-Partner-Code là tuỳ chọn, chỉ để đối chiếu.
Partner backend -> QuestLab
http
x-api-key: <YOUR_API_KEY>
transactionId: ACME-INIT-0001
Content-Type: application/json

Token phiên (token)

  • accessToken nhận được khi khởi tạo người dùng là chuỗi phiên, không phải JWT.
  • Gửi trong header token: {accessToken} ở mọi API /questlab/sdk/v1/** và /auth/**, kể cả khi tải media. Không dùng Authorization: Bearer.
  • Hết hạn sau expiresIn giây. Làm mới bằng POST /auth/refresh; refresh token hết hạn thì khởi tạo lại qua backend.
  • Không khởi tạo lại chỉ để lấy token: mỗi lần khởi tạo thu hồi phiên cũ của người dùng.
App -> QuestLab
http
token: <ACCESS_TOKEN>
Accept-Language: vi

Header

HeaderDùng ở đâuGhi chú
x-api-keyMọi API /questlab/integration/**Chỉ gửi từ backend
transactionIdBắt buộc ở /questlab/integration/**; nên gửi khi nộp bài ở /questlab/sdk/v1Mỗi lượt gọi một mã
tokenAPI /questlab/sdk/v1/** và /auth/** của kịch bản 1, kể cả khi tải mediaKhông dùng Authorization: Bearer
Accept-LanguageKịch bản 1vi để nhận message tiếng Việt
X-Partner-CodeTuỳ chọn ở /questlab/integration/**Lệch với api-key thì nhận 403 (2013)

Biến dùng trong ví dụ

Các ví dụ curl trong tài liệu dùng các biến dưới đây. Thay giá trị trong <...> bằng thông tin QuestLab cấp cho bạn.

Variables
bash
GW="https://gateway.questlab.vn"
API_KEY="<YOUR_API_KEY>"
ACCESS_TOKEN="<ACCESS_TOKEN>"