Autenticação

As requisições autenticadas da API Agilize usam uma chave de acesso vinculada ao projeto.

Antes de começar

Entre na plataforma com um usuário autorizado a gerenciar usuários de sistema.
Crie uma chave diferente para cada integração. Isso facilita identificar e revogar um acesso sem interromper os demais.
Prepare um gerenciador de segredos para armazenar a chave depois da criação.

Gerar uma chave de API

Informe um nome que identifique a integração que usará a chave.
Salve o usuário de sistema.
Copie a chave gerada e armazene-a em local seguro.

A chave é criada automaticamente ao salvar o registro. O campo de nome é apenas descritivo e pode ser usado para indicar o sistema ou processo responsável pelas chamadas.

Cabeçalhos principais

Accept: application/json
x-api-key: SUA_CHAVE_API

Exemplo

curl --request GET \
  --url "https://api.agilize.app/" \
  --header "Accept: application/json" \
  --header "x-api-key: SUA_CHAVE_API"

Segurança

Nunca exponha a chave em código público, documentação pública, logs abertos ou aplicações client-side.
Envie a chave somente para https://api.agilize.app.
Não coloque a chave na URL ou nos parâmetros de consulta.
Se uma chave for exposta, remova o usuário de sistema correspondente e crie uma nova chave para a integração.

Próximos passos

Consulte os limites de requisição.
Veja como montar consultas, ordenação e filtros.
Abra a referência interativa da API para testar um endpoint.