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

Создайте API-ключ и безопасно передавайте его в каждом запросе

Все методы за пределами /public/* требуют API-ключ. Передавайте его в заголовке запроса, а не в URL.

#Как создать ключ

  1. Откройте настройки проекта
    Перейдите в Project → API Access.
  2. Проверьте тариф
    Доступ к закрытым методам входит в тариф Pro.
  3. Создайте ключ
    Укажите понятное имя, например название сервиса или среды.
  4. Сохраните значение
    Скопируйте ключ сразу после создания. Повторно показать его нельзя.

#Как передать ключ

Основной вариант:

X-API-Key
curl "https://dstrends.com/api/v1/trends?region=us" \
  -H "X-API-Key: $DTR_API_KEY"

Также поддерживается Bearer:

Authorization
curl "https://dstrends.com/api/v1/trends?region=us" \
  -H "Authorization: Bearer $DTR_API_KEY"

Используйте один способ в каждом запросе.

#Доступ к рынкам

При создании ключа можно выбрать доступные страны. Запрос закрытого рынка вернёт 403 Forbidden. В списках с несколькими рынками недоступные страны не попадут в ответ. Ключ без ограничений видит все рынки проекта.

#Ошибки доступа

  • 401 Unauthorized: ключ отсутствует, неверен или отозван.
  • 403 Forbidden: ключ не имеет доступа к выбранному рынку.
  • 503 Service Unavailable: сервис временно недоступен. Повторите запрос через время, указанное в Retry-After.