Что нужно заранее
- Разработчик на вашей стороне, который напишет интеграцию.
- Сервер интеграции: ключ хранится только там, из браузера API не работает.
Запись на вашем сайте или в приложении, связь с 1С и своей аналитикой, вебхуки о записях и клиентах.
Открытый API связывает систему с тем, что у организации уже есть: собственный сайт или приложение с записью в своём дизайне, 1С, своя аналитика и другие системы. Вебхуки сразу сообщают вашему серверу, что в системе создали, перенесли или отменили запись, завели или изменили клиента.
API - инструмент для программиста: интеграцию пишет ваш разработчик по документации API, а администратор выпускает ему ключ и настраивает вебхуки. Ключ видит и меняет ровно то, что разрешено его роли, - для интеграции заводят отдельную роль без полного доступа.
Записи через API создаются только в свободное время из расписания, а повтор запроса с ключом идемпотентности не создаст вторую запись. Вебхук, который не дошёл, система повторяет с нарастающей паузой около суток; каждую доставку видно в журнале.
Коротко, по шагам. Подробно, со снимками экрана, - в статьях документации ниже. Настройку можно заказать у нас: цены на настройку.
Заведите для интеграции отдельную роль с нужными правами.
В «Настройки» → «API и вебхуки» выпустите ключ на эту роль и передайте разработчику вместе с адресом API и ссылкой на документацию.
Добавьте подписку на вебхуки: адрес вашего сервера и события; передайте секрет подписи.
Нажмите «Проверить» в строке подписки и следите за журналом доставок.
Как модуль обычно используют организации, которые работают по записи.
Сеть с мобильным приложением показывает свободное время и создаёт записи через API. Всё попадает в тот же журнал, что и запись с сайта.
Вебхук «Визит состоялся» передаёт визит в учётную систему, бухгалтерия не переносит данные руками.
Записи и клиенты регулярно выгружаются в хранилище данных компании и сводятся с рекламными расходами.
Напишите, как сейчас устроена работа, - подскажем, что настроить, и посчитаем цену с нужными модулями.