Autenticação
Como autenticar as requisições com API Key e API Secret.
A HumanTrack API usa autenticação baseada em API Key e API Secret. As duas credenciais são fornecidas pela equipe HumanTrack e valem para todos os módulos da API.
Cabeçalhos obrigatórios
Todas as requisições devem incluir os dois cabeçalhos:
X-Api-Key: sua-api-key-aqui
X-Api-Secret: sua-api-secret-aquiGuarde a API Secret no servidor
Trate a API Secret como uma senha: mantenha-a apenas no servidor da sua plataforma e nunca a exponha em código que roda no navegador ou em aplicativos distribuídos.
Nunca use as credenciais em navegadores ou em páginas públicas, nem para testar requisições. Por isso, a Referência da API mostra exemplos de código, mas não executa requisições.
Exemplo de requisição
curl -X GET "https://api.humantrack.io/third-party/api/v1/forms/library" \
-H "X-Api-Key: sua-api-key-aqui" \
-H "X-Api-Secret: sua-api-secret-aqui" \
-H "Content-Type: application/json"Erros de autenticação
| Código | Significado |
|---|---|
401 | API Key ou API Secret ausentes, inválidas, inativas ou expiradas. |
403 | IP fora da lista permitida da credencial, ou operação não permitida para o profissional. |
Um 403 não se resolve trocando a API Key ou a API Secret: as credenciais estão corretas, mas o
acesso foi negado por IP ou por permissão da operação (por exemplo,
PROFESSIONAL_CLAIM_REQUIRED, quando o profissional ainda não está vinculado a você, ou um limite
do plano do parceiro).
Todas as respostas de erro seguem o mesmo corpo (ErrorResponse):
{
"message": "invalid API key",
"code": "INVALID_API_KEY"
}code é estável e deve ser usado para tratar o erro; message é informativa. As respostas podem
incluir também details (detalhes adicionais) e traceId (identificador de rastreio da
requisição, para o suporte).