Partner API - Confirm Passcode (EAgentTraffic)

Xác nhận mã bảo mật Passcode / PIN của tài khoản đối tác tra cứu thông tin giao thông để lấy JWT Token truy cập cho các phiên làm việc tiếp theo.

Về module EAgentTraffic

Endpoint

URL/ThirdParty/EAgentTraffic/user/confirmPasscode
MethodPOST

Headers schema

HeaderRequiredMô tả
clientId hoặc clientidYesMã định danh đối tác
apiKey hoặc apikeyYesKhóa xác thực API của đối tác

Body schema

FieldTypeRequiredRuleMô tả
usernamestringYesrequired, max 255, alphanumDữ liệu thật — Số CCCD / CMND thật của tài khoản đối tác tra cứu thông tin giao thông.
passcodestringNoalphanum, max 20Dữ liệu thật — Mã Passcode / mã PIN bảo mật thật của tài khoản đối tác.

Sample Request

curl --location '{HOST_NAME}/ThirdParty/EAgentTraffic/user/confirmPasscode' \
  --header 'Content-Type: application/json' \
  --header 'clientId: TESTCLIENT' \
  --header 'apiKey: 07e73e61-0dce-4b39-8ecf-06ef70b35c08' \
  --data '{
    "username": "001201012345",
    "passcode": "123456"
  }'

Success response

{
  "statusCode": 200,
  "error": null,
  "message": "Success",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

Mã lỗi

HTTPMã lỗiMô tả
400Validation ErrorPayload không đúng schema (thiếu username, format sai).
429QUOTA_EXCEEDEDapiKey không hợp lệ hoặc đã vượt quá hạn mức gọi API.
500INCORRECT_PASSWORDMã Passcode / PIN bảo mật không chính xác.
500AGENTETRAFFIC_CONFIRM_PASSCODE_FAILEDGặp lỗi hoặc xác nhận mã Passcode/PIN thất bại với cổng dịch vụ.
500INVALID_USERNAMESố CCCD / tài khoản đối tác không hợp lệ hoặc không tìm thấy.
500UNKNOWN_ERRORLỗi không xác định.

Tham khảo

Dữ liệu và Lưu ý quan trọng cho Developer

Dữ liệu giả lập kiểm thử (Mock Test Data)

Tham khảo kịch bản giả lập từ Google Docs:

Passcode Kịch bản Kết quả giả lập
123456 Passcode hợp lệ Thành công – success = true; trả về token giả lập và thông tin người dùng mẫu.
000000 Passcode không chính xác Thất bại – INCORRECT_PASSWORD.
999999 Lỗi xác nhận Passcode Thất bại – AGENTETRAFFIC_CONFIRM_PASSCODE_FAILED.
Lưu ý phân biệt môi trường:
  • Môi trường Test / Sandbox (Mock): Dùng các mã Passcode giả lập ở bảng trên để kiểm thử đầy đủ luồng thành công và các kịch bản lỗi.
  • Môi trường Thật (Production): Bắt buộc sử dụng số CCCD và mã Passcode thật của tài khoản đối tác đã thiết lập trên hệ thống dịch vụ giao thông.
Sao chép thành công