A autenticação na API é realizada por meio de uma Chave de API. Essa chave permite que nossa plataforma identifique o usuário e autorize a comunicação com os recursos disponíveis.

Se a chave de API for inválida ou não for fornecida, a API responderá com o código HTTP 401 (Unauthorized).

A segurança da Chave de API é de total responsabilidade do cliente. Recomendamos armazená-la de forma segura e nunca expô-la em ambientes públicos, como repositórios de código.

​
Envio da Chave de API nas requisições

A Chave de API deve ser enviada no cabeçalho Authorization, utilizando o formato:

Authorization: Bearer token

​
Como criar sua Chave de API

Assista ao vídeo abaixo para aprender, passo a passo, como gerar sua Chave de API:

​
Gerenciamento de Chaves de API

  • Dê nomes descritivos às suas chaves para facilitar a identificação.
  • É possível definir uma data de expiração para cada chave.
  • Você pode ativar ou desativar uma chave a qualquer momento.
  • Atenção: chaves excluídas não podem ser restauradas.

​
Armazenamento seguro da Chave de API

A Chave de API é gerada no modelo irrecuperável, ou seja, ela será exibida apenas no momento da criação. Por isso, é fundamental copiar e armazenar a chave em um local seguro antes de concluir o processo de criação, pois não será possível recuperá-la posteriormente.