Подключение интеграции через маркетплейс

Как происходит активация интеграции через маркетплейс:

Пользователь нажимает Подключить на странице вашего приложения в маркетплейсе Altegio.
Altegio запросит у пользователя разрешение на предоставление доступа к его ЛК по API. После этого интеграция может быть активирована API запросом с вашей стороны.
Из Altegio пользователь будет перенаправлен на url формы регистрации в вашем сервисе, который вы указали в настройках приложения в поле Registartion redirect url.
К url адресу вашей формы регистрации будет добавлен GET параметр salon_id. Значение этого параметра — идентификатор локации в Altegio.
Пример: https://yoursite.com/signup?salon_id=123

Вы должны отправить запрос в течение 1 часа после того, как пользователь дал согласие на предоставление доступа к его ЛК в Altegio (перешел к вам на страницу регистрации). Если запрос будет отправлен позже, то вы получите ошибку, а пользователю нужно будет заново активировать интеграцию через маркетплейс.

Запрос на подключение

Отправьте со стороны вашего сервиса такой запрос, чтобы подключить интеграцию:

Метод и URL: POST https://app.alteg.io/marketplace/partner/callback — обратите внимание: корень app.alteg.io, а не api.alteg.io/api/v1.
Authorization: Bearer <Partner Token> — ваш Partner Token из раздела Marketplace → Account settings.
Тело: {"salon_id": <ID локации>, "application_id": <ID приложения>} — salon_id это идентификатор локации.
Результат: 201 — связь приложения с локацией переходит из pending в active.
Срок: в течение 1 часа после того, как пользователь предоставил доступ.

Полный пошаговый пример (подключение владельцем → подтверждение → проверка) — в руководстве для разработчиков Install & test your app before moderation.

После отправки АПИ запроса для активации, интеграция с вашим сервисом будет подключена в ЛК локации Altegio:

В личный кабинет клиента будет добавлен ваш системный пользователь. ID системного пользователя вы указываете в настройках приложения в поле «User Id». Вы сможете использовать bearer токен этого пользователя для осуществления запросов к API локации в соответствии с запрошенными вами правами доступа.
На переданные вами адреса вебхуков начнут отправляться события об изменениях в локации.
В случае, если ваша интеграция находится в категории «Уведомления», в настройки локации также будет добавлен ваш API_KEY для отправки системных уведомлений.

Best practices

Рекомендуется отправлять запрос на активацию интеграции сразу после завершения регистрации пользователя на стороне вашего сервиса. После этого вы получите доступ к API локации. Тогда вы сможете по API подтянуть нужные данные о локации, пользователю и упростить для него дальнейшую настройку интеграции на вашей стороне.

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

Обратите внимание

Автоматическая регистрация пользователя в вашей системе

Для упрощения процесса подключения вашей интеграции, вы можете активировать передачу данных пользователя при подключении. В таком случае при подключении интеграции, вы будете получать данные пользователя (имя, телефон, email) и автоматически регистрировать его в своей системе, не заставляя заполнять форму. По нашим данным, использование этой настройки повышает конверсию в подключение на 30-40%. Подробнее.

Подключение интеграции сразу в несколько локаций

Если ваша интеграция работает с несколькими локациями Altegio, то активируйте настройку «Разрешить добавлять приложение в несколько локаций». В таком случае, при подключении, пользователю будет предложено выбрать, в какие локации он хочет установить интеграцию. Подробнее.

Подключение и настройка интеграции в iframe

Вы можете активировать настройку «Открывать форму регистрации в iframe». Тогда, при нажатии на кнопку «Подключить» страница регистрации вашего сервиса будет открываться в табе «Настройки» в карточке вашего приложения в маркетплейсе. Это существенно повышает доверия пользователей к вашему сервису, т.к. взаимодействие с вашим сервисом происходит в привычном интерефейсе Altegio. Подробнее.