Ir para o conteúdo principal
Contrato OpenAPI v0.1.0: Alinhado ao arquivo contracts/openapi.yaml. Endpoints exclusivos do Console (/dashboard/v1) aguardam publicação complementar do backend.

Autenticação e Ambientes

Todas as chamadas à API REST da Conformo Face devem incluir o header X-API-Key com uma chave válida da sua organização.

Header de autenticação

X-API-Key: cf_test_xxxxxxxxxxxxxxxxx

Sandbox vs Produção

Ambiente Prefixo esperado Finalidade
Sandbox cf_test_... Desenvolvimento, testes de integração e validação de fluxo.
Produção cf_live_... Tráfego real após cumprimento dos requisitos de segurança da conta.

Boas práticas de segurança

  • Armazene API keys em variáveis de ambiente ou cofre de segredos no servidor.
  • Crie chaves distintas por serviço ou integrador com o menor escopo necessário (ex: face:compare).
  • Utilize a função de Rotacionar chave no console periodicamente ou imediatamente em caso de suspeita de vazamento.