API de verificação de SMS para autenticação OTP (Guia de integração do desenvolvedor)

Parâmetro da API para verificar agora

Os parâmetros a seguir precisam ser enviados ao usar as APIs VerifyNow.

URLs de base da API Rest

Todos os endpoints da API da plataforma abaixo devem ser prefixados com o seguinte URL:

https://cpaas.messagecentral.com

Gerar token

Ao usar a API de verificação de SMS do Verify Now para enviar códigos de verificação por SMS, a chamada inicial deve ser para a API de geração de token. API de verificação por SMS para enviar códigos de verificação por SMS, a chamada inicial deve ser para a API de geração de tokens.

Essa API retorna um token que deve ser incluído em todas as chamadas subsequentes. É necessário um token de autenticação para validar o usuário e deve ser incluído na seção de cabeçalho de cada solicitação.

Caminho do URL da solicitação:

/auth/v1/authentication/token

cURL

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: */*'

‍

OBSERVAÇÃO: Para converter um comando cURL em código usando o Postman, abra o Postman, importe o comando cURL por meio do botão “Importar” e gere o código no idioma de sua preferência clicando no botão “Código” no lado direito da solicitação.

Resposta JSON

1{
2  "status": Integer,
3  "token": "String"
4}

Enviar OTP

Para enviar OTP em um número de celular, abaixo estão os parâmetros da solicitação. O token de autenticação é necessário para enviar o OTP, que é gerado pela API do token gerado (que você pode encontrar acima na seção Introdução). enviar OTP em um celular O número abaixo são os parâmetros da solicitação. O token de autenticação é necessário para enviar o OTP, que é gerado pela API do token gerado (que você pode encontrar acima na seção Introdução).

Caminho do URL da solicitação:‍

Uma resposta bem-sucedida retornará um código de status 200.

/verification/v3/send

Parâmetros do URL da solicitação:‍

cURL

1curl --location --request POST 'https://cpaas.messagecentral.com/verification/v3/send? 
2countryCode=91&flowType=SMS&mobileNumber=9999999999' \
3--header 'authToken: 
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTMzNDMyQTVGNDIGNzQwNCI6ImIhdCI6MTcxMjExOTA0MCwiZXhwIjo'

‍

OBSERVAÇÃO: Para converter um comando cURL em código usando o Postman, abra o Postman, importe o comando cURL por meio do botão “Importar” e gere o código no idioma de sua preferência clicando no botão “Código” no lado direito da solicitação. Você pode alterar o FlowType com base no canal de sua escolha.

Resposta 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

O método validateOTP é um endpoint da API REST para validar uma senha de uso único (OTP) para clientes.

Caminho do URL da solicitação:

Uma resposta bem-sucedida retornará um código de status 200.

/verification/v3/validateOtp/

cURL

1curl --location 'https://cpaas.messagecentral.com/verification/v3/validateOtp? 
2&verificationId=2949&code=1476' \
3--header 'authToken: 
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTMzNDMyQTVGNDIGNzQwNCI6ImIhdCI6MTcxMjExOTA0MC'

‍

OBSERVAÇÃO: Para converter um comando cURL em código usando o Postman, abra o Postman, importe o comando cURL por meio do botão “Importar” e gere o código no idioma de sua preferência clicando no botão “Código” no lado direito da solicitação.

Resposta JSON

Uma resposta bem-sucedida retornará um código de status 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 resposta

Ajuda e suporte

Para obter suporte de implementação e qualquer feedback, entre em contato conosco em: support@messagecentral.com