Verificação de código de utilização única (OTP)

URL da API

URL utilizado para enviar pedidos HTTP:

https://portal.bulkgate.com/api/1.0/otp/verify

Nota

Se o pedido não chegar ao destino, repita-o no servidor de reserva backup1.bulkgate.com.

Métodos HTTP suportados

POST - application/json

POST /api/1.0/otp/verify HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Tabela de parâmetros

NOME DO PARÂMETRO	VALOR	OBRIGATÓRIO	VALOR PREDEFINIDO
application_id	ID da aplicação	Sim	-
application_token	Token da aplicação	Sim	-
id	ID recebido ao enviar o código de utilização única	Sim	-
code	Código a verificar	Sim	-

Exemplo de pedido

POST /api/1.0/otp/verify HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "id": "otp-id", "code": "0000" }

Resposta

Em caso de sucesso:

{ "data": { "id": "otp-id", "verified": true } }

Em caso de código inválido:

{ "data": { "id": "otp-id", "verified": false } }

Em caso de erro:

{ "type": "unknown_identity", "code": 400, "error": "Unknown identity", "detail": null }

{ "type": "invalid_input_parameters", "code": 400, "error": "Invalid input parameters", "detail": null }

Em que:

type e error (descrição do erro) encontram-se na tabela de tipos de erros
code representa o código de erro HTTP
detail contém informações adicionais sobre o erro

Esta página foi útil?

Perguntar à IA Copiado