Pular para o conteúdo principal

Autenticação

Os endpoints para desenvolvedores da GVR são protegidos por autenticação com chave de API.

URL base​

https://api.genderrecognition.com

Cabeçalho​

Envie sua chave no cabeçalho apiKey:

apiKey: YOUR_API_KEY

O backend interpreta esse cabeçalho como apikey; portanto, em clientes HTTP comuns, não importa se as letras estão em maiúsculas ou minúsculas.

Exemplo​

curl -X POST "https://api.genderrecognition.com/v1/voice-gender-recognition/api/name" \
  -H "Content-Type: application/json" \
  -H "apiKey: YOUR_API_KEY" \
  -d '{
  "firstName": "Alex",
  "lastName": "Morgan"
}'

Quando a autenticação falha​

Chave de API ausente​

{
  "error": "API key is required"
}

Chave de API inválida​

{
  "error": "Invalid API key"
}

Erro interno de autenticação​

{
  "error": "Internal server error"
}

As solicitações também podem falhar quando:

  • a chave não tem cota disponível
  • o corpo da solicitação não passa na validação
  • falta um arquivo enviado, ele excede o tamanho permitido ou não é compatível

A página de cada endpoint lista as respostas de erro específicas daquela API.

Mantenha as chaves em sigilo e troque-as se forem expostas.