Что такое подключение интеграции
Для того, чтобы вы могли работать с АПИ филиала, вам необходимо отправлять запросы с bearer токеном пользователя, которые имеет права на осуществление нужных вам операции в этом филиале.
Также для корректной работы интеграции вашего сервиса с Yclients вам может потребоваться получать от Yclients вебхуки об операциях с данными филиалами, например вебхуки об изменении записи в филиале.
Для этого существует двухэтапный механизм подключения интеграции:
- Пользователь решает подключить интеграцию с вашим сервисом и разрешает вам добавить в его филиал вебхуки и пользователя, для API запросов
- Вы отправляете API запрос, который добавит в филиал ваши адреса для получения вебхуков и вашего системного пользователя с указанным вами набором прав для доступа к АПИ.
Как происходит активация интеграции со сторонними сервисами через маркетплейс Yclients:
- Пользователь нажимает “Подключить” на странице вашего приложения в маркетплейсе YCLIENTS
- YCLIENTS запросит у пользователя разрешение на предоставление доступа к его ЛК по АПИ. После этого интеграция может быть активирована АПИ запросом с вашей стороны.
- Из YCLIENTS пользователь будет перенаправлен на url формы регистрации в вашем сервисе
- К url адресу вашей формы регистрации будет добавлен GET параметр salon_id. Значение этого параметра - идентификатор филиала в YCLIENTS. Пример https://yoursite.com/signup?salon_id=123
- После прохождения регистрации/авторизации на стороне вашего сервиса, вам необходимо будет передать в отправить АПИ запрос для активации интеграции.
- Вы должны отправить запрос в течение 1 часа после того, как пользователь дал согласие на предоставление досткупа к его ЛК в YCLIENTS. Если запрос будет отправлен позже, то вы получите ошибку, а пользователю нужно будет заново активировать интеграцию через маркетплейс.
После отправки АПИ запроса для активации, интеграция с вашим сервисом будет подключена в ЛК филиала Yclients.
- В личный кабинет клиента будет добавлен ваш системный пользователь со всеми необходимыми правами. Вы сможете использовать bearer токен этого пользователя для осуществления запросов к API филиала в соответсвии с запрошенными вами правами доступа.
- На указанные вами адреса вебхуков начнут отправляться события об изменениях в записях филиала.
- В случае, если ваша интеграция находится в категории “Уведомления”, в настройки филиала также будет добавлен ваш API_KEY для отправки системных уведомлений.
Best practises
Рекомендуется отправлять запрос на активацию интеграции сразу после завершения регистрации пользователя на стороне вашего сервиса. После этого вы получите доступ к АПИ филиала. Тогда вы сможете по АПИ подтянуть нужные данные о филиале, пользователю и упростить для него дальнейшую настройку интеграции на вашей стороне.
Также не забудьте предусмотреть то, что из маркетплейса YCLIENTS к вам может прийти уже зарегистрированный/авторизованный в вашем сервисе пользователь. Отправляйте запрос на активацию интеграции в маркетплейсе не только при регистрации, но при логине пользователя в ваш сервис или переходе пользователя из маркетплейса YCLIENTS сразу в личный кабинет вашего сервиса.