Авторизация

Запросы к API подписываются секретным ключом, который передаётся в заголовке. Для платежей и для выплат используются разные ключи.

Ключи доступа

Ключи генерируются в личном кабинете в настройках интеграции. У кассы и у пользователя есть по два ключа: секретный — для запросов к API, дополнительный — для проверки подписи входящих webhook.

КлючДля чегоЗаголовок
Секретный ключ кассыЗапросы по платежам и тарифам кассыx-api-key
Дополнительный ключ кассыПроверка подписи webhook платежейx-api-sha256-signature
Секретный ключ пользователяЗапросы по выплатамx-api-signature-sha256
Дополнительный ключ пользователяПроверка подписи webhook выплатx-api-sha256-signature
Для чего
Запросы по платежам и тарифам кассы
Заголовок
x-api-key
Для чего
Проверка подписи webhook платежей
Заголовок
x-api-sha256-signature
Для чего
Запросы по выплатам
Заголовок
x-api-signature-sha256
Для чего
Проверка подписи webhook выплат
Заголовок
x-api-sha256-signature
Храните ключи только на сервере. Не передавайте их в браузер, мобильное приложение или публичный репозиторий. Если ключ скомпрометирован — перевыпустите его в личном кабинете.

Платежи

Касса определяется по shop_id — он передаётся в теле запроса, в query-параметрах или в пути. Секретный ключ этой кассы передаётся в заголовке x-api-key.

  1. 1.Accept: application/json
  2. 2.Content-Type: application/json
  3. 3.x-api-key: {ShopSecretKey}

Выплаты

Пользователь определяется по user_id — он передаётся в теле запроса или в query-параметрах. Секретный ключ пользователя передаётся в заголовке x-api-signature-sha256.

  1. 1.Accept: application/json
  2. 2.Content-Type: application/json
  3. 3.x-api-signature-sha256: {UserSecretKey}

Если авторизация не прошла

  • API вернёт код 401, если shop_id / user_id не найден или ключ не подходит.
  • Проверьте, что ключ относится именно к этой кассе или пользователю.
  • Проверьте название заголовка: для платежей — x-api-key, для выплат — x-api-signature-sha256.
  • Формат ошибки описан в разделе «Ответы и ошибки».