Pular para o conteúdo principal

Autenticação

A API Annie Insights usa autenticação de chave de API por meio do cabeçalho HTTP x-api-key.

Como funciona

Inclua sua chave de API em cada solicitação como um cabeçalho HTTP:

x-api-key: YOUR_API_KEY

Exemplo

curl -X POST \
https://api.annie-insights.com/api/v2/clinical-images \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{"PatientID": "P-001", "TimeStamp": "2026-05-24", "ImageName": "https://..."}'

Obtendo uma chave de API

TipoComo conseguirCaso de uso
Chave da caixa de areiaDisponível na página SandboxTeste e desenvolvimento
Chave de produçãoEntre em contato com api-support@hcds.aiIntegração de produção

Melhores práticas de segurança

aviso

Nunca exponha sua chave de API no código do lado do cliente. Sempre faça chamadas de API do seu servidor back-end.

  • Armazene chaves com segurança — Use variáveis ​​de ambiente ou um gerenciador de segredos
  • Alterne as chaves periodicamente — Solicite uma nova chave se suspeitar de comprometimento
  • Use apenas HTTPS — Todos os endpoints da API exigem criptografia TLS
  • Monitore o uso — Acompanhe sua contagem de solicitações por meio de cabeçalhos de resposta

Respostas de erro

Se a autenticação falhar, a API retornará:

{
"error": "Unauthorized",
"message": "Invalid or missing API key",
"statusCode": 401
}

Consulte Error Handling para todos os códigos de erro.