Документация

# API для интеграций

Создайте API-ключ для серверной генерации и получения документов.

API нужен для внешних серверных интеграций. Для ручной работы в карточке сделки и для триггера Digital Pipeline ключ создавать не требуется.

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

  1. Откройте Настройки amoCRM → Документы Rubikon → API.
  2. Нажмите «Создать ключ».
  3. Укажите название интеграции.
  4. Выберите только необходимые права:
    • templates:read — чтение шаблонов;
    • generation:write — запуск генерации;
    • jobs:read — проверка состояния заданий;
    • documents:read — получение документов;
    • documents:delete — удаление документов.
  5. Создайте ключ и сразу сохраните секрет в защищённом хранилище: повторно он не показывается.

# Безопасное использование

  • Используйте ключ только на сервере и передавайте его в заголовке авторизации Bearer.
  • Не размещайте секрет в браузерном коде, публичном репозитории, инструкции или скриншоте.
  • Для запросов генерации и создания редакции передавайте уникальный Idempotency-Key, чтобы повторный запрос не создал дубликат.
  • Отзывайте ключ, если он больше не используется или мог быть раскрыт.

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