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

API SupDesk находится по адресу:

https://api.supdesk.app/v1

Каждый запрос аутентифицируется с помощью API-ключа, передаваемого как токен Bearer:

curl https://api.supdesk.app/v1/submissions \
  -H "Authorization: Bearer sd_live_..."

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

Создавайте ключи в консоли в разделе Настройки рабочего пространства → API-ключи. Каждый ключ:

• Ограничен одним проектом — всё, что вы читаете или пишете через него, принадлежит этому проекту;
• Начинается с узнаваемого префикса, например sd_live_, так что вы можете идентифицировать ключи в файлах конфигурации, не раскрывая их;
• Показан один раз при создании. SupDesk хранит только хеш ключа — если вы его потеряете, отзывите его и создайте новый.

Обработка ключей

Обрабатывайте API-ключи как пароли. Вызывайте API только с серверов — API не имеет поддержки CORS, намеренно, поэтому ключи недоступны из браузера. Если ключ протекает, отзовите его в консоли; отзыв немедленно вступает в силу.

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

Отсутствующий, неправильный, отозванный или неизвестный ключ всегда возвращает один и тот же ответ, поэтому вызывающие не могут выяснить, какие ключи существуют:

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

Доступ в чтение vs. запись

Все планы могут читать через API. Конечные точки записи (POST, PATCH, DELETE) требуют, чтобы рабочее пространство было на платном плане Pro — на Free записи возвращают ошибку 403 forbidden. Смотрите Лимиты запросов и использование.