Partner API - Confirm OTP (EAgentTraffic)

Xác nhận mã OTP đăng nhập đối tác tra cứu thông tin giao thông. Sau khi gửi mã OTP qua API requestLoginByOTP, đối tác gọi API này kèm mã OTP người dùng nhận được để hoàn tất quy trình xác thực.

Về module EAgentTraffic

Endpoint

URL/ThirdParty/EAgentTraffic/user/confirmOTP
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.
otpstringNoalphanum, max 20Dữ liệu thật — Mã xác thực OTP thật nhận được qua SMS gửi về số điện thoại đối tác.

Sample Request 

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

Success response

{
  "statusCode": 200,
  "error": null,
  "message": "Success",
  "data": {
    "success": true,
    "message": "OTP verified successfully"
  }
}

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_OTPMã OTP không chính xác hoặc đã hết thời gian hiệu lực.
500AGENTETRAFFIC_CONFIRM_OTP_FAILEDGặp lỗi hoặc xác nhận mã OTP thất bại với cổng dịch vụ.
500INVALID_USERNAMETài khoản đối tác không tồn tại trong hệ thống.
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:

OTP Kịch bản Kết quả giả lập
123456 OTP 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 OTP không chính xác Thất bại – INCORRECT_OTP.
999999 Lỗi xác nhận OTP Thất bại – AGENTETRAFFIC_CONFIRM_OTP_FAILED.
Lưu ý phân biệt môi trường:
  • Môi trường Test / Sandbox (Mock): Dùng các mã OTP giả lập ở bảng trên để kiểm thử đầy đủ luồng thành công và các trường hợp lỗi.
  • Môi trường Thật (Production): API kết nối trực tiếp đến cổng xác thực dịch vụ giao thông, username và otp bắt buộc phải là dữ liệu thật do hệ thống gửi về SMS.
Sao chép thành công