API и Вебхуки: Подключите наш сервис к вашим приложениям
Добро пожаловать в центр для разработчиков! Эта страница — ваш мост между нашим сервисом и вашими собственными приложениями, сайтами или CRM-системами. Здесь вы можете получить ключи для безопасного доступа, настроить автоматические уведомления (вебхуки) и найти всю необходимую техническую документацию.
Давайте рассмотрим каждую вкладку подробно.
Вкладка «Ключи доступа (API)»
Что это? API-ключ — это как секретный пароль для вашего приложения. Когда ваше приложение отправляет нам запрос (например, "сгенерируй мне письмо!"), этот ключ подтверждает, что запрос пришел именно от вас и у вас есть на это права.
Как с этим работать?
- Создание ключа: Нажмите на кнопку «+ Создать новый ключ». Вам будет предложено дать ключу понятное название (например, «Ключ для моей CRM»). Это поможет вам не забыть, где используется тот или иной ключ.
- Безопасность — это главное: После создания ключ будет показан вам только один раз. Обязательно скопируйте его и сохраните в надёжном месте. Из соображений безопасности мы больше никогда не покажем его полностью.
- Управление ключами: Все ваши созданные ключи будут отображаться в списке. Вы увидите их названия, последние 4 символа (для идентификации) и дату последнего использования.
- Отзыв ключа: Если ключ был скомпрометирован или больше не нужен, вы можете нажать кнопку «Отозвать». Ключ будет немедленно деактивирован, и с его помощью больше нельзя будет получить доступ к вашим данным.
Вкладка «Вебхуки»
Что это? Если API — это когда ваше приложение спрашивает нас о чём-то, то вебхук — это когда наш сервис сам сообщает вашему приложению о событии. Это автоматическое уведомление.
В нашем случае, вебхуки тесно связаны с функцией «AI-Автопилот». Как только Автопилот по вашему расписанию сгенерирует новое письмо, мы можем мгновенно отправить его на указанный вами адрес (URL).
Как это настроить?
- Выберите проект: Сначала в выпадающем списке укажите, для какого из ваших проектов вы хотите настроить вебхук. У каждого проекта может быть свой, уникальный вебхук.
- Добавьте URL: Нажмите «+ Добавить вебхук» и вставьте в появившемся окне URL-адрес вашего сервера, который готов принять от нас данные.
- Готово! Теперь, как только задача в Автопилоте для этого проекта будет выполнена, мы отправим POST-запрос с HTML-кодом сгенерированного письма на ваш URL. Вы также можете в любой момент отредактировать или удалить этот URL.
Вкладка «Документация»
Что это? Это подробная инструкция для программистов. Здесь описаны все технические правила взаимодействия с нашим сервисом: какие адреса использовать для запросов, какие данные отправлять и что вы получите в ответ.
Как ей пользоваться?
- Удобная навигация: Слева находится меню со всеми разделами документации. Вы можете кликать на них для быстрой навигации. А при прокрутке страницы нужный пункт в меню будет подсвечиваться автоматически, чтобы вы всегда знали, где находитесь.
- Все, что нужно знать: Мы описали все шаги — от аутентификации с помощью вашего API-ключа до правил генерации контента и обработки возможных ошибок.
- Примеры кода: Мы знаем, как важны готовые примеры! В конце документации вы найдете разделы с готовыми к копированию фрагментами кода на популярных языках (JavaScript, PHP, Python), чтобы вы могли максимально быстро начать работу.