Что нужно для API

Интеграционный API платформы авторизуется парой:

  • accountId — идентификатор аккаунта;
  • API-токен — секретный ключ доступа.

Где получить

  1. Откройте Settings → API.
  2. Создайте API-ключ — платформа выдаст токен.
  3. Скопируйте токен сразу: он показывается один раз.

Аккаунт и токен хранятся также в Settings → Credentials — разделе сохранённых кредов для интеграций.

Как использовать

Заголовки запросов к API (см. Аутентификация в API):

Authorization: Basic base64(accountId:token)

Пример первого запроса — в статье Первый запрос к API.

Безопасность

  • Токен — как пароль: не публикуйте в репозиториях, передавайте через секрет-хранилища.
  • Отдельный токен на интеграцию — так проще отозвать доступ одному сервису, не ломая остальные.
  • Отзыв ключа: удалите его в Settings → API — интеграция с этим ключом перестанет работать немедленно.

При смене ключа

Сначала создайте новый ключ и обновите интеграцию, затем отзывайте старый — иначе будет простой.

Список всех методов — в Справочнике API; полный Swagger с моделями — app.plaia.ru/api/methods.