OAuth2 Authentication

O método de autenticação para todas as API é 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 1 hora 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.

Headers

Name	Type	Description
Content-Type	string	form-data

Request Body

Name	Type	Description
grant_type *	string	Informar sempre "client_credentials"
client_id *	string	ID de identificação da aplicação que irá consumir a API. Essa informação é fornecida pela D1
client_secret*	string	Chave secreta para a autenticação da aplicação. Essa informação é fornecida pela D1
audience *	array	Identificação das APIs que serão consumidas. Seu valor deve ser um array contendo todas as APIs

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":86400, 
    "expires_on":1614971159 
} 

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.

Response

{
   "access_token":"eyJz93a...k4laUWw",
   "token_type":"Bearer",
   "expires_in":86400,
   "expires_on":1614971159
  }

Parâmetro	Descrição
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.

Tenant Id

Identifica a qual conta, previamente cadastrada na aplicação, deve ser utilizada para as operações.

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