Đăng ký Soft OTP

Tạo một đăng ký (registration) SmartOTP cho một thiết bị và trả về registration_id, một activation_key dùng một lần, và token của thiết bị. Cả ba đều bắt buộc đối với Kích hoạt.

Endpoint

POST /api/v1/saas-sotp/register
Content-Type: application/json

{
  "partner_id": "{{partner_id}}",
  "partner_key": "{{partner_key}}",
  "user_id": "{{user_id}}",
  "device_id": "{{device_id}}",
  "registration_time": "{{registration_time}}"
}

Tham số:

Tham số	Kiểu	Bắt buộc	Mặc định	Mô tả
partner_id	string	Có	—	Partner ID.
partner_key	string	Có	—	Partner key.
user_id	string	Có	—	User ID.
device_id	string	Không	—	UUID của thiết bị.
registration_time	string	Không	—	Thời điểm request này được gửi.

Trả về: RegisterResponse

INFO

user_id là bắt buộc — khóa bí mật của client được suy ra từ nó.

Ví dụ request

curl --location --request POST '<BASE_URL>/saas-sotp/register' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data-raw '{
    "partner_id": "{{partner_id}}",
    "partner_key": "{{partner_key}}",
    "user_id": "{{user_id}}",
    "device_id": "{{device_id}}",
    "registration_time": "{{registration_time}}"
  }'

Response

{
  "success": true,
  "code": 1,
  "message": "success",
  "data": {
    "registration_id": "reg_00000001",
    "activation_key": "fake_activation_key",
    "token": "fake_device_token"
  }
}

Trường	Kiểu	Mô tả
success	bool	Trạng thái của request.
code	int	status code — 1 khi thành công.
data.registration_id	string	ID đăng ký duy nhất.
data.activation_key	string	Mã dùng một lần (one-time password) để kích hoạt SmartOTP trên thiết bị.
data.token	string	Access token của người dùng, bắt buộc đối với hầu hết các endpoint khác.

WARNING

activation_key chỉ dùng một lần và có thời hạn ngắn. Nếu kích hoạt thất bại, hãy gọi lại Đăng ký để lấy một key mới thay vì thử lại Kích hoạt với key cũ.

Lỗi

Mã	Mô tả
3	Parameter invalid
103	Thông tin Partner không chính xác — Partner details are incorrect.
121	Yêu cầu vượt giới hạn. Vui lòng thử lại sau ít phút. — Request limit exceeded.
126	Có lỗi xảy ra vui lòng thử lại. — An error occurred, please retry.
190001	Thông tin không hợp lệ, device_id đã kích hoạt Soft-OTP — Device already has SmartOTP activated.

Các mã 121 và 126 cũng có thể được trả về. Hãy xử lý chúng.

Bước tiếp theo

• Kích hoạt — đổi activation key lấy khóa bí mật của client
• Lấy trạng thái — kiểm tra xem một thiết bị đã được đăng ký hay chưa