Validación de OTP
Endpoint
POST https://otp.api.engagelab.cc/v1/verifications
Autenticación
Utiliza la autenticación básica HTTP e incluye Authorization en la cabecera HTTP:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Este bloque de código se muestra en una ventana flotante
base64_auth_string se genera de la siguiente forma: base64(dev_key:dev_secret)
Ejemplo de solicitud
Cabecera de la solicitud
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Este bloque de código se muestra en una ventana flotante
Cuerpo de la solicitud
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Este bloque de código se muestra en una ventana flotante
Parámetros de la solicitud
| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | El ID del mensaje correspondiente al código de verificación, devuelto por la API /messages |
| verify_code | String | Required | El código de verificación que se va a validar |
Parámetros de respuesta
Respuesta correcta
| Field | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | El ID del mensaje correspondiente al código de verificación, devuelto por la API /v1/messages |
| verify_code | String | Required | El código de verificación que se va a validar |
| verified | Boolean | Required | El resultado de la validación. true indica que la validación se ha realizado correctamente y false indica que ha fallado |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Este bloque de código se muestra en una ventana flotante
Nota: Si se realiza una solicitud de validación para el código de verificación del mismo mensaje y el código se valida correctamente, cualquier solicitud posterior a esta API de validación fallará y devolverá un mensaje indicando que el código de verificación de ese mensaje ya ha sido validado. En otras palabras, los códigos de verificación que ya se han validado correctamente no pueden volver a validarse.
Respuesta de error
El código de estado HTTP es 4xx o 5xx, y el cuerpo de la respuesta contiene los siguientes campos:
| Field | Type | Required | Description |
|---|---|---|---|
| code | int | Required | Código de error. Para obtener más información, consulta Códigos de error |
| message | String | Required | Detalles del error |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
Este bloque de código se muestra en una ventana flotante
Códigos de error
| Error Code | HTTP Code | Description |
|---|---|---|
| 1000 | 500 | Error interno |
| 2001 | 401 | Error de autenticación: no se ha proporcionado el token correcto |
| 2002 | 401 | Error de autenticación: el token ha caducado o ha sido deshabilitado |
| 2004 | 403 | No tienes permiso para llamar a esta API |
| 3001 | 400 | Formato de parámetro de solicitud no válido. Comprueba si el contenido JSON cumple el formato de parámetro requerido |
| 3002 | 400 | Parámetros de solicitud no válidos. Comprueba si los parámetros de la solicitud cumplen los requisitos |
| 3003 | 400 | El código de verificación ha caducado o ya ha sido verificado. Para las respuestas con este código de error, debe enviarse un nuevo mensaje con un código de verificación |
| 3011 | 400 | Código de verificación caducado |
| 4001 | 400 | El mensaje no existe |
