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

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

1. Пользователь нажимает «Подключить» на странице вашего приложения в маркетплейсе YCLIENTS.

2. YCLIENTS запросит у пользователя разрешение на предоставление доступа к его ЛК по API. После этого интеграция может быть активирована API запросом с вашей стороны.

3. Из YCLIENTS пользователь будет перенаправлен на url формы регистрации в вашем сервисе, который вы указали в настройках приложения в поле «Registartion redirect url».

a. К url адресу вашей формы регистрации будет добавлен GET параметр salon_id. Значение этого параметра — идентификатор филиала в YCLIENTS. Пример: https://yoursite.com/signup?salon_id=123

4. После прохождения регистрации/авторизации на стороне вашего сервиса, вам необходимо будет отправить API запрос для активации интеграции.

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

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

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

Best practices

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

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

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

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

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

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

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

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

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