# Подключение и авторизация

Интеграция по API всегда привязана к платежной ссылке. Ссылка задает настройки по умолчанию для всех счетов, которые вы через нее создаете: оформление страницы, способы оплаты, сроки рассрочки, чеки и редиректы. В запросе часть этих настроек можно переопределить для конкретного счета.

# Шаг 1. Создайте платежную ссылку

В личном кабинете откройте «Ссылки» → «Новая ссылка» и заполните три вкладки:

  1. Корзина и визуальное оформление — заголовок, описание, логотип, ссылка на вашу оферту. Корзину можно не заполнять, если товары вы будете передавать в API.
  2. Способы оплаты — включите все способы, которые могут понадобиться в счетах по этой ссылке. В API для конкретного счета можно выбрать часть из них, но не способ, который на ссылке не настроен. Для карт и кредита выберите проект, для кредита — продукты и сроки.
  3. Завершение и интеграция — становится доступна после создания ссылки. Здесь настраиваются редиректы и интеграция.

Подробная инструкция по настройке ссылки — в базе знаний (opens new window).

# Шаг 2. Включите интеграцию и создайте API-ключ

На вкладке «Завершение и интеграция» в блоке «Интеграция через API»:

  1. Включите прием через API.
  2. Создайте API-ключ и передайте его разработчику. Ключ работает только для этой ссылки.
  3. Скопируйте ID ссылки — это значение параметра payment_options_id. Его видно в адресе страницы ссылки: https://secure-app.mandarin.io/dashboard/invoices/links/2d28e8bf-0d60-45ca-b8b4-172820086117 → 2d28e8bf-0d60-45ca-b8b4-172820086117

ОБРАТИТЕ ВНИМАНИЕ!

Если интеграция на ссылке выключена или ключ деактивирован, запросы будут отклонены с ошибкой 401.

# Шаг 3. Настройте вебхук

В том же блоке включите «Отправлять колбэки (Webhook)» и укажите URL вашего обработчика. На него будут приходить уведомления о каждом изменении счета. Формат и правила повторной отправки — в разделе Вебхуки.

# Точки входа

Метод Адрес
Создание счета POST https://secure-app.mandarin.io/api/v1/public/invoices/
Статус счета GET https://secure-app.mandarin.io/api/v1/public/invoices/{invoice_id}/check-state/
Список транзакций GET https://secure-app.mandarin.io/api/v1/public/invoice-transactions/
Страница оплаты для клиента https://secure-app.mandarin.io/payment/{invoice_id}

# Авторизация

Передавайте API-ключ платежной ссылки в заголовке X-API-Key:

X-API-Key: 3f2b1c9e-4a7d-4e2b-9c1a-8d5e6f7a8b9c

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

БЕЗОПАСНОСТЬ

Храните API-ключ только на сервере. Не передавайте его в браузер или мобильное приложение.