Перейти к основному содержимому

Аутентификация

Конечные точки GVR для разработчиков защищены аутентификацией по ключу API.

Базовый URL​

https://api.genderrecognition.com

Заголовок​

Передавайте ключ в заголовке apiKey:

apiKey: YOUR_API_KEY

Сервер читает этот заголовок как apikey, поэтому регистр букв в имени заголовка не имеет значения для обычных HTTP-клиентов.

Пример​

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"
}'

Ошибки аутентификации​

Отсутствует ключ API​

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

Недействительный ключ API​

{
  "error": "Invalid API key"
}

Внутренняя ошибка аутентификации​

{
  "error": "Internal server error"
}

Запрос также может завершиться ошибкой, если:

  • для ключа закончилась квота
  • тело запроса не прошло проверку
  • загруженный файл отсутствует, слишком велик или имеет неподдерживаемый формат

На странице каждой конечной точки перечислены характерные для неё ошибки.

Не разглашайте ключи и обновляйте их, если они стали доступны посторонним.