01. OAuth2 Authentication

‌Por meio de nossas APIs é possível trocar dados com outras empresas e, com base nas informações fornecidas, executar automações personalizadas de acordo com o perfil dos destinatários, com segurança e respeitando a lei geral de proteção de dados.

Jornadas podem ser iniciadas por meio de chamadas de API, que contém todas as informações necessárias para sua execução, e todos os dados gerados pelas interações dos destinatários com as comunicações que fazem parte de uma automação podem ser enviados para nossos clientes atualizarem seus bancos de dados.

OAuth2 Authentication

O método de autenticação para todas as APIs é o OAuth2 Authentication, um protocolo de autorização que permite que uma aplicação se autentique em outra.

Login

É através do login que o consumidor da API irá solicitar o token de acesso enviando as suas credenciais.

O token terá uma validade padrão de 23 horas e 30 minutos e o consumidor deverá renová-los antes que expire solicitando novamente através das credenciais.

Request

POST URL: https://apicore.d1.cx/login/{tenantid}/token

Com esse método o consumidor da API irá solicitar o token de acesso enviando as suas credenciais.

O {tenantid} identifica a qual conta cadastrada na aplicação deve ser utilizada para as operações. Essa informação é fornecida pela D1.

Parameters

Header

`TenantId`	string	Identificação do tenant
`Content-type`	string	form-data

Body

`Grand_type`	string	Informar sempre `client_credentials`
Clientid	string	ID de identificação da aplicação que irá consumir a API. Essa informação é fornecida pela Zenvia.
`Clientsecret`	string	Chave secreta para a autenticação da aplicação. Essa informação é fornecida pela Zenvia.
`audience`	array	Identificação das APIs que serão consumidas. Seu valor deve ser um array contendo todas as APIs.

Responses

🟢 200 OK

Atributos:

access_token: token de acesso às APIs.
token_type: tipo do token.
expires_in: tempo em segundos de validade do token.
expires_on: timestamp de expiração do token.

{ 
    "access_token":"eyJz93a...k4laUWw", 
    "token_type":"Bearer", 
    "expires_in":60, 
    "expires_on":1718471223 
}

Body exemplo

(form-data)
Grand_type: "client_credentials"
Clientid: "b725eddb-064d-4b27-a944-4219a421bba1"
ClientSecret: "N4nHHuyIax/t0bJ8uyIOvPaNSSX7QTCaN/6WUjt+LsU="
audience: ["https://apicore.d1.cx"]

Parâmetro	Descrição
`Tenantid`	Identificação do tenant.
`audience`	Identificação da API que será consumida. Informar apenas uma URL.
`Clientid`	ID de identificação da aplicação que irá consumir a API.
`Grand_type`	Informar sempre `client_credentials`
`Clientsecret`	Chave secreta para a autenticação da aplicação.

Todas as informações de acesso serão fornecidas pela DirectOne.

Como podemos ajudar?