Parámetro de API para Verify Now
Los siguientes parámetros deben enviarse al usar las API VerifyNow.
URL base de API Rest
Todos los puntos finales de la API de la plataforma que aparecen a continuación deben tener como prefijo la siguiente URL:
https://cpaas.messagecentral.comGenerar token
Al usar la API de verificación por SMS de Verify Now para enviar códigos de verificación por SMS, la llamada inicial debe ser a la API de generación de tokens.
Esta API devuelve un token que debe incluirse en todas las llamadas posteriores. Se necesita un token de autenticación para validar al usuario y debe incluirse en la sección de encabezado de cada solicitud.
Request URL Path:
/auth/v1/authentication/tokencURL
1curl --location 'https://cpaas.messagecentral.com/auth/v1/authentication/token?
2customerId=%3CCustomerId%3E&key=%3CBase64%20Encrypted%20password%3E&scope=NEW&country=91
3&email=test%40messagecentral.com' \
4--header 'accept: */*'
NOTA: Para convertir un comando cURL en código con Postman, abre Postman, importa el comando cURL mediante el botón «Importar» y, a continuación, genera el código en tu idioma preferido haciendo clic en el botón «Código» situado a la derecha de la solicitud.
Response JSON
1{
2 "status": Integer,
3 "token": "String"
4}Enviar OTP
Para enviar OTP a un número de teléfono móvil, a continuación se muestran los parámetros de solicitud. El token de autenticación es necesario para enviar la OTP, que es generada por la API de tokens generada (que puedes encontrar más arriba en la sección Introducción).
Ruta URL de solicitud:
Una respuesta correcta devolverá un código de estado 200.
/verification/v3/sendParámetros de URL de solicitud:
cURL
1curl --location --request POST 'https://cpaas.messagecentral.com/verification/v3/send?
2countryCode=91&flowType=SMS&mobileNumber=9999999999' \
3--header 'authToken:
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTMzNDMyQTVGNDIGNzQwNCI6ImIhdCI6MTcxMjExOTA0MCwiZXhwIjo'
NOTA: Para convertir un comando cURL en código con Postman, abre Postman, importa el comando cURL mediante el botón «Importar» y, a continuación, genera el código en tu idioma preferido haciendo clic en el botón «Código» situado a la derecha de la solicitud. Puedes cambiar el FlowType según el canal que elijas.
Respuesta JSON
1{
2 "responseCode": 200,
3 "message": "SUCCESS",
4 "data": {
5 "verificationId": "xxxx",
6 "mobileNumber": "xxxx",
7 "responseCode": "200",
8 "errorMessage": null,
9 "timeout": "60",
10 "smCLI": null,
11 "transactionId": "xxxx"
12 }
13}Validar OTP
El método validateOTP es un punto final de la API REST para validar una contraseña de un solo uso (OTP) para los clientes.
Ruta URL de solicitud:
Una respuesta correcta devolverá un código de estado 200.
/verification/v3/validateOtp/- For multiple language support
- by default is English
- For now we support English only
cURL
1curl --location 'https://cpaas.messagecentral.com/verification/v3/validateOtp?
2&verificationId=2949&code=1476' \
3--header 'authToken:
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTMzNDMyQTVGNDIGNzQwNCI6ImIhdCI6MTcxMjExOTA0MC'
NOTA: Para convertir un comando cURL en código con Postman, abre Postman, importa el comando cURL mediante el botón «Importar» y, a continuación, genera el código en tu idioma preferido haciendo clic en el botón «Código» situado a la derecha de la solicitud.
Respuesta JSON
Una respuesta correcta devolverá un código de estado 200.
1{
2 "responseCode": 200,
3 "message": "SUCCESS",
4 "data": {
5 "verficationId": "xxxx",
6 "mobileNumber": "xxxx",
7 "responseCode": "200",
8 "errorMessage": null,
9 "verificationStatus": "VERIFICATION_COMPLETED",
10 "authToken": null,
11 "transactionId": "xxxx"
12 }
13}Códigos de respuesta
Ayuda y soporte
Para obtener asistencia sobre la implementación y cualquier comentario, ponte en contacto con nosotros en: support@messagecentral.com
Preguntas frecuentes
1. ¿Cómo puedo implementar con código personalizado?
Puedes usar postman para reescribir las llamadas a la API en tu lenguaje de programación preferido. Tendrías que usar: -
- Método POST para enviar SMS
- Método GET para validar SMS OTP
2. ¿Por qué aparece el error «Método no permitido» o el código de error 405?
Debes asegurarte de que la URL del punto final de la API de token coincida con la definida en la documentación. Lo mismo se menciona a continuación: -
a. API de token mediante el método GET
b. Enviar API mediante el método POST
c. Validar la API mediante el método GET
3. ¿Cómo pruebo las API de verificación por SMS?
Puedes usar Postman para probar las API de verificación de SMS de Message Central.
4. ¿Por qué aparece la página «Error de etiqueta blanca»?
Si aparece la página de error de etiqueta blanca, debe comprobar si hay los siguientes errores: -
a. Estás utilizando un paquete de API incorrecto
b. No ha sustituido los marcadores de posición por los valores reales
c. La curva de la API es incorrecta
d. La ubicación de Curl no se ha cambiado a «producción» en lugar de «puesta en escena»
5. ¿Por qué aparece el código de error 401?
Esto puede deberse a que la API o el token son incorrectos. Asegúrese de haber seguido nuestra documentación de API para conocer los valores correctos de los tokens.
6. ¿Por qué aparece el código de error 400 o «Solicitud incorrecta» en Postman?
Hay varias razones para una «solicitud incorrecta» en Postman. Puedes comprobar los siguientes motivos probables: -
a. Compruebe si el AuthToken es correcto
b. Compruebe si falta algún parámetro en la API
c. El encabezado debe pasarse en este formato: application-x-www-form-urlencoded
7. ¿Cómo puedo generar AuthToken?
Para generar el AuthToken en Postman, debes: -
a. Busque una «clave» en la API GET
b. Tendrías que copiar esa clave y codificar la misma usando Base64 - https://www.base64encode.org/
c. Coloque la contraseña codificada en el marcador de posición «Clave»
d. Pulsa la API GET
Obtendrías un AuthToken.
8. ¿Dónde uso el AuthToken?
Deberás poner el authToken en el encabezado de la API SEND.
9. ¿Cuáles son todos los parámetros que debo cambiar en la API GET para generar el token?
Deberás cambiar el país, la identificación del cliente, el correo electrónico y la clave. El alcance siempre será igual a = «NUEVO»
10. ¿Cuáles son todos los parámetros que debo cambiar en la API SEND?
Deberás cambiar el código de país, la identificación del cliente, la longitud del límite y el número de teléfono móvil.
