Mục lục tài liệu
Kịch bản tích hợp
QuestLab hỗ trợ hai kịch bản. Mỗi người dùng đi theo một kịch bản, không trộn API của hai kịch bản trong cùng một lượt làm việc.
| Tiêu chí | Kịch bản 1: Người dùng định danh | Kịch bản 2: Khách vãng lai |
|---|---|---|
| Khai báo người dùng | Có, qua externalUserId | Không, chỉ cần deviceId |
| Xác thực | x-api-key ở backend khi khởi tạo, sau đó ứng dụng dùng header token | x-api-key + transactionId ở mọi request, gọi từ backend |
| Hồ sơ, gợi ý nhiệm vụ, lịch sử | Có | Không |
| Bài kiểm tra đầu vào | Có, với chiến dịch yêu cầu | Không gặp |
| Phạm vi dự án | Dự án chung + dự án riêng của bạn | Chỉ dự án riêng của bạn |
Kịch bản 1: Khuyến nghị (Người dùng định danh)Khuyến nghị
Backend của bạn khởi tạo người dùng bằng x-api-key rồi trả cặp token cho ứng dụng. Sau đó ứng dụng gọi thẳng QuestLab bằng header token để nhận nhiệm vụ, đọc nội dung và nộp bài. Api key không bao giờ rời khỏi backend.
Kịch bản 1 (Người dùng định danh)
Ứng dụng (SDK)
Backend đối tác
QuestLab
- Khởi tạo phiên
- Ứng dụng (SDK) gửi tới Backend đối tác:Yêu cầu phiên cho người dùng
- Backend đối tác: Xác định externalUserId
- Backend đối tác gửi tới QuestLab:
- QuestLab gửi tới Backend đối tác:accessToken, refreshToken
- Backend đối tác gửi tới Ứng dụng (SDK):Trả cặp token
- Ứng dụng (SDK): Lưu token an toàn
- Làm nhiệm vụ (header token)
- Ứng dụng (SDK) gửi tới QuestLab:
- QuestLab gửi tới Ứng dụng (SDK):assignedTaskId, taskUuid
- Ứng dụng (SDK) gửi tới QuestLab:
- QuestLab gửi tới Ứng dụng (SDK):Nội dung nhiệm vụ
- Ứng dụng (SDK) gửi tới QuestLab:
- QuestLab gửi tới Ứng dụng (SDK):Kết quả nộp bài
- Gia hạn phiên
- Ứng dụng (SDK) gửi tới QuestLab:
- QuestLab gửi tới Ứng dụng (SDK):Cặp token mới
Ứng dụng (SDK)
Backend đối tác
QuestLab
API theo thứ tự gọi
Khi nào chọn
- Ứng dụng của bạn có tài khoản người dùng, hoặc muốn giữ lịch sử và tiến độ của từng người.
- Muốn người dùng nhận nhiệm vụ theo hồ sơ (nghề nghiệp, kỹ năng, khu vực) và nhận gợi ý nhiệm vụ.
- Muốn mở các chiến dịch có bài kiểm tra đầu vào.
Kịch bản 2: Khách vãng lai (Guest)
Không khai báo người dùng; danh tính gắn với deviceId. Mọi request đều dùng x-api-key, nên ứng dụng gửi yêu cầu qua backend của bạn và backend gọi QuestLab, kể cả khi tải media.
Kịch bản 2 (Khách vãng lai)
Ứng dụng (SDK)
Backend đối tác
QuestLab
- Nhận nhiệm vụ
- Ứng dụng (SDK) gửi tới Backend đối tác:Yêu cầu nhiệm vụ (deviceId)
- Backend đối tác: Gắn x-api-key, transactionId
- Backend đối tác gửi tới QuestLab:
- QuestLab gửi tới Backend đối tác:assignedTaskId + nội dung
- Backend đối tác gửi tới Ứng dụng (SDK):Nội dung nhiệm vụ
- Ứng dụng (SDK): Lưu assignedTaskId
- Nộp bài
- Ứng dụng (SDK) gửi tới Backend đối tác:Kết quả gán nhãn
- Backend đối tác: Gắn x-api-key, transactionId
- Backend đối tác gửi tới QuestLab:
- QuestLab gửi tới Backend đối tác:Kết quả nộp bài
- Backend đối tác gửi tới Ứng dụng (SDK):Xác nhận
Ứng dụng (SDK)
Backend đối tác
QuestLab
Khách vãng lai chỉ nhận nhiệm vụ thuộc dự án đã gán cho tài khoản tích hợp của bạn. Chưa có dự án nào được gán thì mọi request đều nhận
2025. Hãy liên hệ QuestLab để cấu hình phạm vi dự án.API theo thứ tự gọi
Khi nào chọn
- Muốn tích hợp nhanh nhất, không quản lý người dùng.
- Chỉ phân phối nhiệm vụ thuộc dự án riêng của bạn.
- Người dùng làm nhiệm vụ ngay, không qua bài kiểm tra.
Khách vãng lai và người dùng định danh là hai danh tính khác nhau, tiến độ không tự chuyển từ kịch bản 2 sang kịch bản 1. Nếu sau này có thể cho người dùng đăng nhập, hãy cân nhắc dùng kịch bản 1 ngay từ đầu với
externalUserId = "anon_" + deviceId để giữ lịch sử làm việc.