Справочник разработчика

Заголовки запроса

Для всех запросов к API нужен API-ключ. Зарегистрируйтесь бесплатно, чтобы получить ключ и 1 000 кредитов каждый месяц.

Заголовки запроса

Для всех запросов к API нужен API-ключ. Зарегистрируйтесь бесплатно, чтобы получить ключ и 1 000 кредитов каждый месяц.

  • Content-Type: application/json (обязателен для POST запросов)
  • Accept: application/json (опционально но рекомендуется)
  • X-API-Key: Ваш API ключ (получите бесплатно на /dashboard)
  • Authorization: Bearer your-api-key (альтернатива X-API-Key)
  • Idempotency-Key: необязательный, для POST-запросов, списывающих кредиты. Повторный запрос с тем же ключом и идентичным содержимым в течение 24 часов возвращает сохраненный ответ с Idempotent-Replayed: true и ничего не списывает повторно. Использование ключа для другого запроса возвращает 422 IDEMPOTENCY_KEY_REUSED, а дубликат, отправленный, пока первый запрос еще выполняется, возвращает 409 IDEMPOTENCY_IN_PROGRESS. Ответы больше 1 МиБ и ошибки с возвратом кредитов не сохраняются, поэтому повторный запрос выполняется как обычно. Ключ состоит из 1-255 печатных символов ASCII, например это UUID.
  • DomScan-Naming: необязательный. snake возвращает каждый ключ ответа в camelCase в формате snake_case, так же как naming=snake. Если переданы оба, приоритет у параметра запроса. См. ключи snake_case.