For the complete documentation index, see llms.txt. This page is also available as Markdown.

Autenticação

Autentique uma conta de serviço da API com credenciais de cliente OAuth 2.0.

As APIs da Eseye usam a concessão de credenciais do cliente do OAuth 2.0. Esse fluxo autentica uma conta de serviço de API em vez de um usuário individual do Infinity.

Ele foi projetado para integrações servidor a servidor que podem armazenar credenciais com segurança.

Como a autenticação funciona

  1. Sua aplicação envia seu ID do cliente e seu segredo do cliente para o Solicitar token de acesso.

  2. A Eseye verifica a conta de serviço e retorna um token de acesso.

  3. Sua aplicação envia o token de acesso com cada requisição de API.

  4. Quando o token expira, sua aplicação solicita um novo.

Contas de serviço

Uma conta de serviço de API identifica uma integração e controla o que essa integração pode fazer.

A Eseye provisiona a conta de serviço e fornece:

  • Um ID do cliente

  • Um segredo do cliente

  • A região da AWS usada para autenticação

  • Acesso às APIs e operações acordadas

O ID do cliente identifica a conta de serviço. O segredo do cliente prova que sua aplicação está autorizada a usá-la.

A requisição de token sempre usa o api/api escopo. Alterar esse valor não concede acesso adicional. As permissões atribuídas à conta de serviço determinam quais operações de API o token pode autorizar.

Tokens de acesso

Uma requisição de autenticação bem-sucedida retorna um token de portador OAuth 2.0. Inclua-o no Cabeçalhos da requisição de cada requisição de API protegida:

Os tokens de acesso expiram após uma hora. O fluxo de credenciais do cliente não exige que um usuário faça login novamente. Solicite outro token usando as mesmas credenciais da conta de serviço quando o token atual expirar.

Sua aplicação deve reutilizar um token válido em vez de solicitar um novo token antes de cada chamada de API.

Endpoint de token

Solicite tokens no endpoint de produção para sua região da AWS:

Por exemplo:

Consulte Solicitar token de acesso para a requisição completa.

Solicite um token de acesso

O serviço de token usa um endpoint regional. Por exemplo:

O Solicitar token de acesso inclui os cabeçalhos, parâmetros de formulário, resposta e exemplo de requisição.

Proteja suas credenciais e tokens

  • Armazene o segredo do cliente em uma variável de ambiente ou gerenciador de segredos.

  • Solicite tokens somente de uma aplicação confiável no lado do servidor.

  • Não exponha credenciais no código do navegador ou de aplicativo móvel.

  • Não faça commit de credenciais ou tokens no controle de versão.

  • Não grave credenciais ou tokens de acesso completos nos logs da aplicação.

  • Sempre envie credenciais e tokens por HTTPS.

Permissões

Um token de acesso só pode autorizar operações permitidas pela sua conta de serviço.

Atualizado

Isto foi útil?