Autenticação
A API utiliza um mecanismo de autenticação baseado em chaves de API (API Keys). Cada chave de API está associada a um usuário do Portal e representa sua identidade durante as solicitações feitas à API. Não é necessário obter um token de acesso prévio nem concluir um processo de autenticação adicional.Chave de API
A chave de API é o único mecanismo de autenticação aceito pela plataforma. Características:- Deve ser incluída em todas as solicitações.
- Identifica o usuário que faz a requisição.
- Limita o acesso à organização à qual o usuário pertence.
Autorização
O acesso aos recursos da API é controlado por meio de um sistema de autorização baseado em papéis. A autorização é aplicada em dois níveis:- Nível de endpoint. Determina quais papéis podem acessar cada endpoint.
- Nível de ação. Restringe operações específicas, como criar, modificar ou excluir recursos, de acordo com as permissões do usuário.
O acesso aos recursos depende das permissões do usuário definidas no Portal. Nem todos os endpoints estão disponíveis para todos os papéis.
Boas práticas
Para proteger as integrações que utilizam a API, recomenda-se:- Manter as chaves de API em um local seguro.
- Não compartilhá-las nem incluí-las em código-fonte público.
- Rotacionar as chaves periodicamente.
- Revogar imediatamente qualquer chave que possa ter sido comprometida.