Autenticação e autorização

A API da Flexxible protege o acesso aos seus recursos mediante um modelo de segurança baseado em autenticação e autorização.

A autenticação permite identificar o usuário que realiza a solicitação, enquanto a autorização determina a quais recursos e operações pode acessar com base em seus permissões.

dica

Para aprender a gerar uma chave de API, autenticar-se e realizar a primeira solicitação, consulte o guia Primeiros passos.

Autenticação

A API utiliza um mecanismo de autenticação baseado em chaves de API (Chaves de API).

Cada chave de API está associada a um usuário do Portal e representa sua identidade durante as solicitações realizadas à API. Não é necessário obter um token de acesso prévio nem completar um processo de autenticação adicional.

Chave de API

A chave de API é o único mecanismo de autenticação aceito pela plataforma.

Recursos:

• Deve ser incluída em todas as solicitações.
• Identifica o usuário que faz a solicitação.
• Limita o acesso à organização à qual o usuário pertence.

Autorização

O acesso aos recursos da API é controlado por um sistema de autorização baseado em papéis.

A autorização se aplica em dois níveis:

1. Nível de endpoint. Determina quais papéis podem acessar cada endpoint.
2. 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.

nota

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, é recomendado:

• Manter as chaves de API em um lugar seguro.
• Não compartilhá-las nem incluí-las em código fonte público.
• Atualizar periodicamente as chaves.
• Revogar imediatamente qualquer chave que possa ter sido comprometida.