Каждый публичный метод требует API-ключ Coldy в HTTP-заголовке Authorization.

Authorization: Bearer YOUR_API_KEY

Создание ключа

  1. Откройте Настройки → Интеграции.
  2. Выберите API Keys.
  3. Создайте ключ для нужной организации.
  4. Сразу скопируйте его: полное значение показывается только один раз.
  5. Сохраните ключ в менеджере секретов или защищённой серверной переменной окружения.

Ключ привязан к организации. Один и тот же ID ресурса может быть недоступен с ключом другой организации.

Аутентифицированный запрос

curl --request GET \
  --url https://developer.coldy.ai/api/v1/accounts \
  --header "Authorization: Bearer $COLDY_API_KEY" \
  --header "Accept: application/json"

Для JSON-тела запроса передавайте Content-Type: application/json.

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

API возвращает 401 Unauthorized, если заголовок отсутствует или имеет неверный формат, ключ недействителен либо не связан с организацией.

{
  "message": ["Unauthorized"],
  "error": "Unauthorized",
  "statusCode": 401
}

Не повторяйте запрос с 401 автоматически. Проверьте полный ключ, схему Bearer и принадлежность ключа нужной организации.

Смена ключа

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