Geração de Token (2FA)

Essa API será utilizada quando for necessário a autenticação em dois fatores (2FA)

Request

Certifique-se que sua API está autenticada utilizando o OAuth2 Authentication.

Token

POST URL: https://apicore.d1.cx/tfa/token

Utilize estes parâmetros para geração de token em ambiente de produção

Para ambiente de homologação, utilize como endpoint: https://apicore.stg.d1.cx/tfa/token

Headers

NameTypeDescription

Content-Type*

string

application/json

Authorization*

string

Bearer [OAUTH2-AUTHENTICATION-ACCESS_TOKEN]

TenantId

string

[TENANT-ID] - Identifica a qual conta previamente cadastrada na aplicação deve ser utilizada. Essa informação é fornecida pela D1.

Request Body

NameTypeDescription

tfaProjectId*

string

O objetivo desse campo é identificar qual o projeto de 2FA que será utilizado. Essa informação é fornecida pela D1.

clientId*

string

Código do cliente.

recipient*

string

E-mail ou telefone para ser enviado o token.

integrationId*

string

Código de integração da requisição, serve para futuras consultas ou recebimento de webhook.

tokenExpirationTimeInMinutes*

string

Minutos para expiração do token.

template*

string

A mensagem a ser enviada no corpo do e-mail ou do sms deve conter a variável ${token} que vai ser substituída pelo token gerado.

emailSubject*

string

Assunto da mensagem para quando o token for enviado por e-mail.

{
    "token": "982421",
    "recipient": "5511999999999",
    "expiresDate": "2021-06-08T03:00:00.000000Z"
}

Atributos:

token: é o token gerado.

recipient: valor informado para o campo recipient durante o request.

expiresDate: É a data e hora de expiração do token em formato ISO-86001

Response

HTTP/1.1 201 CREATED

{
   "token": "982421",
   "recipient": "5511999999999",
   "expiresDate": "2021-06-08T03:00:00.000000Z"
}


CamposDescrição

token

É o token gerado.

recipient

É o valor informado para o campo recipient durante o request.

expiresDate

É a data e hora de expiração do token em formato ISO-86001 (https://en.wikipedia.org/wiki/ISO_8601)

HTTP/1.1 400 BAD REQUEST

{
  "type": "about:blank",
  "title": "BadRequest"
  "status": 400
  "detail": "Detalhes sobre o erro"
  "instance": "/token"
}
CamposDescrição

type

Sempre será “about:blank”

title

Sempre será “BadRequest”

status

Sempre será 400

detail

Conterá informações detalhadas sobre o erro

Headers

  • Content-Type: application/json

  • Authorization: Bearer [OAUTH2-AUTHENTICATION-ACCESS_TOKEN]

  • TenantId: [TENANT-ID]

Exemplo de requisição

{
  "tfaProjectId": "12345",
  "clientId": "12345",
  "recipient": "5511999999999",
  "integrationId": "46299F1DF4C9C9CCEDB4D49DAE6C254",
  "tokenExpirationTimeInMinutes": 20,
  "template": "Seu token é ${token}.",
  "emailSubject": "Token"
}
CamposDescrição

tfaProjectId

O objetivo desse campo é identificar qual o projeto de 2FA que será utilizado. Essa informação é fornecida pela D1.

clientId

Código do cliente.

recipient

E-mail ou telefone para ser enviado o token.

integrationId

Código de integração da requisição, serve para futuras consultas ou recebimento de webhook.

tokenExpirationTimeInMinutes

Minutos para expiração do token.

template

A mensagem a ser enviada no corpo do e-mail ou do sms deve conter a variável ${token} que vai ser substiruida pelo token gerado.

emailSubject

Assunto da mensagem para quando o token for enviado por e-mail.

Last updated