Обзор интеграции

Что вы подключаете

Integration API связывает вашу систему с Yario через один набор методов. Через него можно создавать обращения, обмениваться сообщениями и, если это предусмотрено договором, передавать анкеты мерчантов на проверку.

Вам не нужно копировать внутреннее устройство Yario или поднимать отдельный API специально для нашей платформы.

Обычный сценарий выглядит так:

1. ваша система проверяет тестовый ключ и получает список доступных подключений;
2. создаёт новое обращение или открывает существующее;
3. отправляет и получает сообщения;
4. принимает уведомления о действиях менеджера Yario;
5. при подключённой проверке мерчантов получает анкету и возвращает решение KYC.

Нажмите на схему, чтобы открыть её в полном размере.

Основные понятия

Понятие	Что это означает
Приложение	Интеграция вашей организации с Yario
Среда	Изолированный тестовый (test) или рабочий (live) контур
Подключение (installation)	Связь приложения с конкретной компанией в Yario
Раздел API (capability)	Набор функций, разрешённый для этого подключения
Обращение (ticket)	Общая рабочая карточка партнёра и менеджера Yario
Анкета	Зафиксированный набор данных мерчанта для KYC-проверки

Один ключ видит только данные своего приложения и своей среды. При создании ресурса всегда явно передавайте installationId, чтобы запрос попал в нужную компанию.

Какие разделы API доступны

Код	Когда доступен	Что позволяет делать
tickets	Всегда	Работать с обращениями, сообщениями и вложениями
merchant_onboarding	После отдельного подключения	Читать анкеты мерчантов и возвращать результат KYC

Фактически доступные разделы приходят в ответе GET /v1/installations. Не определяйте доступ по названию компании или типу партнёра — проверяйте capabilities подключения и разрешения (scopes) ключа.

Как работать с идентификаторами

• Все публичные идентификаторы ресурсов имеют формат UUID.
• installationId определяет компанию Yario, с которой работает запрос.
• ticketId связывает обращение между системами и не раскрывает внутренний номер Yario.
• externalReference можно использовать для стабильного идентификатора из вашей системы.
• Не используйте отображаемое название компании как технический ключ.
• Не переносите идентификаторы между тестовой и рабочей средой.

Совместимость новых версий

Текущая версия API указана в адресе: /v1. В неё могут добавляться необязательные поля, новые типы уведомлений и новые значения разделов API.

Клиент должен спокойно пропускать неизвестные поля. Неизвестное уведомление сохраните для диагностики и подтвердите успешным ответом, чтобы Yario не отправлял его повторно.

Что делать дальше

Если тестового ключа ещё нет, перейдите к регистрации и получению доступа. Если ключ уже получен, настройте доступ и безопасное хранение ключей, а затем подключите обращения и сообщения.

Навигация: начало работы · регистрация · описание API · тестирование · готовый пример на GitHub