1. Autenticação

Obtenção do Token de Autenticação:

Para começar a usar nossa API, você precisa gerar um token de autenticação usando as seguintes credenciais:

Parâmetros Necessários:

ParâmetroDescriçãoTipoExemploObrigatório
client_idSeu identificador único de cliente.-"client_id": "seu_client_id"Sim
client_secretSeu segredo de cliente, que não deve ser compartilhado.-"client_secret": "seu_client_secret"Sim
scopesUma lista de escopos que definem o nível de acesso que o token proporcionará.-"scopes": ["api-external", "api-caas", "api-bu-caas"]Sim

Exemplo de Corpo da Requisição:

{ 
  "client_id": "seu_client_id", 
  "client_secret": "seu_client_secret", 
  "scopes": ["api-external", "api-caas", "api-bu-caas"] 
}

Resposta de Autenticação:

Após a solicitação bem-sucedida, você receberá um token de acesso que deve ser usado como Bearer Token nas chamadas subsequentes para os endpoints da API.

Exemplo de Resposta bem sucedida (200 OK):

{ 
 "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWQiOjkyLCJ...",
  "expire_at": "2022-10-19T16:22:43.329Z"
}
 
  • access_token: O token de acesso que você utilizará nas solicitações subsequentes.
  • expire_at: A data e hora de expiração do token.

Uso do Token de Acesso:

Inclua o token de acesso como um cabeçalho de autorização em todas as solicitações subsequentes para autenticar sua sessão. O cabeçalho deve ser formatado como segue:

Authorization: Bearer seu_token_de_acesso

⚠️

Considerações de Segurança:

  • Nunca exponha seu client_secret publicamente.
  • Certifique-se de solicitar apenas os escopos necessários para sua aplicação.
  • Trate o access_token como confidencial e apenas o transmita através de conexões seguras.