Перейти к содержанию

API-ключи

API-ключи используются для аутентификации JSON-RPC запросов от внешних систем.

Создание

Администрирование → API-ключи → Создать.

  1. Укажите название (например: PayTaxi интеграция).
  2. Выберите разрешения — какие методы доступны по этому ключу.
  3. Нажмите «Создать».
  4. Скопируйте ключ сразу — он показывается только один раз.

Формат

schemix_1u-SqFfBUVTXm8b0VgeVzG1EYlVpPgMKy1SsJLCOSYY

Ключ передаётся в заголовке X-API-Key:

X-API-Key: schemix_1u-SqFfBUVTXm8b0VgeVzG1EYlVpPgMKy1SsJLCOSYY

Разрешения

Метод Описание
process.start Запуск процессов
process.status Получение статуса
process.cancel Отмена процессов
task.list Список задач
task.complete Завершение задач
conversation.send Отправка сообщений
conversation.list Список диалогов

Для каждого ключа разрешения настраиваются отдельно — выдавайте только те, которые действительно нужны интеграции.

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

  • Ключ хранится как SHA-256 hash — даже при утечке БД сам ключ не восстановить.
  • Деактивируйте скомпрометированные ключи немедленно.
  • Не передавайте ключи через мессенджеры — используйте менеджер секретов.
  • Для каждой интеграции создавайте отдельный ключ, чтобы можно было отозвать доступ точечно.