Autenticação
Autentique suas integrações com uma chave dedicada ao seu escritório.
Autenticação com X-API-Key
A API de Integração utiliza uma chave no cabeçalho X-API-Key. Envie a chave em todas as operações que a exigirem. O formato da chave é expedit_<prefixo>.<segredo>.
A chave resolve o contexto do escritório no servidor. Você não precisa enviar um identificador de escritório para escolher o contexto de acesso.
curl 'https://api.expedit.com.br/v2/processos?page=1&perPage=15' \
--header "X-API-Key: ${EXPEDIT_API_KEY}" \
--header 'Accept: application/json'Obtenção e ciclo de vida
A criação, regeneração e revogação são ações da gestão interna de tokens da Expedit. Solicite a chave à administração do escritório. Essas rotas de gestão não fazem parte desta referência pública.
Há uma chave ativa por escritório. As opções implementadas de expiração são 30, 90 ou 365 dias, além de sem expiração. Ao regenerar, a chave anterior é revogada; atualize as integrações que a utilizavam.
A regeneração invalida a credencial anterior. Combine a atualização das variáveis de ambiente dos serviços que dependem dela.
Proteja sua credencial
- Armazene a chave em variáveis de ambiente ou em um gerenciador de segredos no servidor.
- Use HTTPS em todas as chamadas.
- Evite incluir a chave em URLs, logs, repositórios ou código entregue ao navegador.
- Na documentação, configure sua chave pelo botão API key no cabeçalho ou no modal de teste. Ela será reutilizada entre os endpoints e guardada na sessão desta aba para a API configurada. Use Limpar chave para removê-la. A chave não é salva em localStorage nem copiada nos exemplos.
No Next.js, não use o prefixo NEXT_PUBLIC_ para a credencial da API.
Quando a chave não é aceita
Uma chave com prefixo reconhecido que esteja inválida, expirada ou revogada recebe 401. Para chave ausente ou outros contextos de segurança, consulte também as respostas da operação.
{
"error": "invalid_token",
"error_description": "API token inválido, expirado ou revogado."
}