API и интеграции

Как получать API-ключи, подключать интеграции и работать с sandbox.

Получение API-ключей

  1. Войдите в личный кабинет компании
  2. Перейдите в раздел «Настройки» → «API-ключи»
  3. Нажмите «Создать ключ»
  4. Укажите название (например: «production», «1С», «тест»)
  5. Скопируйте токен — он показывается только один раз при создании
Храните токен в безопасном месте. При утечке — немедленно отзовите ключ и создайте новый.

Права доступа (abilities)

Каждый API-ключ может иметь ограниченные права. Например: только чтение исполнителей или только создание выплат. Настройте права в соответствии с принципом наименьших привилегий.

  • executors:read, executors:write
  • payouts:read, payouts:create
  • documents:read
  • npd:check

Sandbox (UAT)

Для тестирования интеграции используйте UAT-окружение. Sandbox позволяет:

  • Проверять все эндпоинты без реальных выплат
  • Тестировать сценарии с ошибками
  • Отлаживать интеграцию с 1С или другими системами

UAT-доступ предоставляется автоматически при активации компании в production. Используйте отдельный API-ключ для sandbox.

Webhooks

Настройте webhook-эндпоинты для получения уведомлений о событиях: изменение статуса выплаты, подписание документа и т.п. События подписываются HMAC — проверяйте подпись на своей стороне.

Webhooks настраиваются через API: POST /api/v1/webhooks. Секрет для подписи возвращается только при создании.

Что дальше

Подробное описание аутентификации, эндпоинтов и идемпотентности — в гайде по API.

Вернуться в базу знаний