Разделы справки

Интеграции

Подключение сайта или бота: ключ, вебхук, подписки на события, лог доставок.

Что такое интеграция

Интеграция — это ваш сайт, бот или другая система, которая работает с Истоком по API: заводит контакты, читает каталог, создаёт покупки и ссылки на оплату. В обратную сторону Исток присылает ей события: «Оплата прошла», «Контакт обновлён» и другие.

Вкладку «Интеграции» в «Настройках» видят владелец и администратор. Пока интеграций нет, вкладка предлагает создать первую.

1. «Интеграций пока нет» — кнопка «Создать интеграцию» под текстом открывает диалог создания.

Список интеграций

1. «Создать интеграцию».
2. «Ключ» — начало и конец API-ключа; целиком он показывается только при создании.
3. «Вебхук» — адрес, куда Исток отправляет события.
4. «Без вебхука» — интеграция только читает и пишет данные, событий не получает.
5. «Подписки» — сколько типов событий получает интеграция.
6. Статус — переключатель. Выключенная интеграция теряет доступ по ключу, а события для неё копятся и уйдут после включения.
7. Действия — открыть карточку или удалить.

Клик по строке открывает карточку интеграции.

Создание интеграции

1. «Название» — как вы называете систему: «Сайт студии», «Телеграм-бот».
2. «Webhook URL» — адрес на стороне сайта, куда присылать события. Даёт разработчик.
3. Подсказка — без адреса интеграция работает только по запросам, без событий.
4. «Подписки на события» — какие события отправлять; можно оставить пустым и настроить позже.
5. Событие — у каждого подпись и код, который увидит разработчик.
6. «Создать интеграцию».

После создания Исток один раз показывает ключ и секрет.

1. Предупреждение — ключ показывается только сейчас. Потом его можно будет только перевыпустить.
2. «API-ключ» — им сайт представляется Истоку.
3. «Копировать» — скопируйте ключ и передайте разработчику безопасным способом.
4. «Секрет вебхука» — им сайт проверяет, что событие действительно от Истока. Секрет можно посмотреть и позже.
5. «Копировать».
6. «Готово».

Внимание. Ключ даёт полный доступ к контактам и покупкам проекта. Не отправляйте его в открытых чатах и не публикуйте в коде сайта, который видят посетители.

Карточка интеграции

1. Назад — к списку интеграций.
2. «Настройки» — реквизиты, подписки, ключ и секрет.
3. «Лог доставок» — что и когда Исток отправлял на вебхук.
4. «Активна» — переключатель; выключенная интеграция получает ошибку на каждый запрос.
5. «Название».
6. «Webhook URL».
7. «Сохранить» — применяет изменения названия и адреса.
8. «Подписки на события» — текущий набор.
9. «Изменить» — открыть список событий.
10. «Ключ и секрет».
11. «Перевыпустить» — новый API-ключ; старый перестаёт работать сразу.
12. «Показать» — открыть секрет вебхука.
13. «Копировать» — секрет в буфер обмена.
14. «Перегенерировать» — новый секрет; сайт нужно обновить, иначе он перестанет принимать события.
15. «Удалить интеграцию» — ключ отключится немедленно, недоставленные события пропадут.

Подписки на события сгруппированы по разделам.

1. «Контакты» — создан, обновлён, удалён.
2. «Покупки» — покупка создана, статус покупки изменился.
3. «Оплата» — оплата прошла, оплата не прошла.
4. «Каталог» — продукт и предложение созданы, обновлены, удалены.
5. Код события — справа от подписи; именно его увидит разработчик в поле type.
6. «Сохранить».

Секрет вебхука скрыт точками; кнопка «Показать» открывает его.

1. Секрет — строка, начинающаяся с whsec_.
2. «Скрыть».

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

1. «Перевыпустить API-ключ?» — старый ключ перестанет работать немедленно.
2. «Перевыпустить» — новый ключ покажется один раз, как при создании.

Лог доставок

Лог показывает каждое событие, которое Исток отправлял на вебхук этой интеграции, и чем закончилась отправка.

1. «Все статусы» — фильтр: только ожидающие, доставленные или недоставленные.
2. «Событие» — код события.
3. «Доставлено» — сайт ответил успешно.
4. «Попытки» — сколько раз пробовали из восьми возможных.
5. «Ответ» — код ответа сайта или текст ошибки.
6. «Следующая попытка» — когда Исток попробует снова, если доставка не удалась.

Если сайт не ответил или ответил ошибкой, Исток повторяет отправку: через минуту, потом через 3, 9, 27 минут и дальше с ростом паузы, всего до восьми попыток.

1. «Ожидает» — доставка не удалась, запланирован повтор.
2. «Попытки» — сколько уже сделано из восьми.
3. «Следующая попытка» — время повтора.

Когда все восемь попыток исчерпаны, статус становится «Не доставлено», и Исток больше не отправляет это событие. Записи хранятся 30 дней. Пока у интеграции не было ни одного события, лог пуст.

1. «Событий ещё не было» — записи появятся после первого события из подписок.