Как использовать публичный API (интерфейс прикладного программирования) systeme.io

В этой статье вы узнаете, как настроить и использовать публичный API systeme.io, включая генерацию ключей API и выполняемые действия.

1. Что такое API?

Аббревиатура API расшифровывается как «интерфейс прикладного программирования» (Application Programming Interface) — набор инструкций, с помощью которых платформа предоставляет услуги другим платформам. Это стратегический шлюз для внешних разработчиков, позволяющий им получать доступ к определенным функциям или данным платформы структурированным и безопасным способом. Можно рассматривать его как набор готовых к использованию инструментов, которые упрощают создание новых приложений, сервисов или их комбинаций.

Вкратце, systeme.io открывает доступ другим платформам для предоставления своих услуг там, где это приносит дополнительную ценность.

2. Как работает наш публичный API?

Наш API предоставляет тщательно отобранный набор функций, позволяя разработчикам взаимодействовать с нашей платформой прозрачно и эффективно. Если вы хотите узнать больше о том, как это работает, вы можете ознакомиться с нашей официальной документацией по API.

3. Как сгенерировать ключи API

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

Для подключения внешней интеграции вам сначала нужно сгенерировать защищенный ключ API. Нажмите на свою фотографию профиля и выберите «Настройки» (1). В левом меню нажмите «Ключи MCP и API» (2).

Прокрутите вниз до раздела «Публичные ключи API» и нажмите «Создать» (3).

Дайте своему ключу имя, установите дату истечения срока действия и нажмите «Сохранить» (4).

Примечание: Чтобы ваш API-ключ оставался активным неограниченное время, оставьте поле «Срок действия» пустым.

Ваш ключ готов!

4. Что можно делать с нашим API?

Наш API открывает ряд интересных возможностей. Ниже вы найдете основные действия, которые можно выполнять с помощью нашего публичного API:

а. Контакты, теги и пользовательские поля:

• Управление контактами: создание новых контактов, обновление существующих, отображение списка вашей аудитории с расширенными фильтрами или удаление контактов.
• Управление тегами: создание, назначение, отображение и удаление тегов из контактов.
• Пользовательские поля: получение доступных пользовательских полей контактов и их идентификаторов (слагов) для корректного заполнения информации о контакте.

б. Управление рассылками и кампаниями:

• Рассылки: создание новых черновиков, обновление существующих, определение целевой аудитории (используя включение/исключение по тегам), настройка данных отправителя, планирование или удаление планирования, отправка тестовых писем, прямая отправка рассылок, удаление черновиков и получение конкретных рассылок.
• Кампании: создание, получение, обновление и удаление полных кампаний электронной почты, а также отдельных шагов кампании.

в. Управление воронками и редактор страниц:

• Управление воронками: создание новых воронок, добавление в них новых шагов (страниц) и получение списка всех отдельных шагов в конкретной воронке.
• Редактор страниц: сохранение сгенерированного содержимого страниц непосредственно в шагах воронки или страницах веб-сайта (полная замена) и получение JSON-схем для определенных типов страниц.

г. Управление тарифными планами и купонами:

• Создание, редактирование и удаление: создание новых тарифных планов и купонов, а также частичное обновление и удаление существующих.
• Список и поиск: просмотр всех существующих тарифных планов и купонов или поиск определенных планов по их ID.

д. Управление курсами и студентами:

• Курсы и студенты: получение списка существующих курсов и студентов, которые в настоящее время на них обучаются.
• Зачисление студентов: программное зачисление контактов в ваши отдельные курсы.

Примечание по курсам: поддержка пакетов курсов будет добавлена ​​в будущих обновлениях.

е. Управление сообществами:

• Сообщества: получение списка существующих сообществ и списка текущих участников конкретного сообщества.
• Приглашение участников: программное приглашение новых пользователей в ваши сообщества, предоставляя их контактный ID.

ж. Управление правилами автоматизации:

• Правила автоматизации: программное связывание общих событий и действий, обновление существующих правил (например, изменение действия при сохранении триггера) или мягкое удаление правил.
• Список и получение: просмотр ваших правил автоматизации или получение конкретного правила по его ID.

з. Управление подписками:

• Подписки: получение списка всех ресурсов в подписке от сторонних платформ и отмена подписки немедленно или по окончании расчетного периода.

и. Управление веб-хуками:

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

к. Управление цифровыми продуктами:

• Цифровые продукты: создание, обновление, удаление и получение конкретных цифровых продуктов.
• Связывание тарифных планов: программное создание или привязка тарифных планов непосредственно к вашим цифровым продуктам.

л. Управление настройками предложений и продаж:

• Управление предложениями: создание и настройка предложений для потоков продаж (таких как формы заказа, предложения upsell и downsell).
• Настройка продаж: присоединение цифровых продуктов к предложениям и управление такими настройками, как купоны, дополнительные товары, валюта, методы оплаты, налоги и партнерские комиссии.

Примечание по предложениям: эта функция в настоящее время поддерживает только цифровые продукты. Поддержка физических продуктов будет добавлена в будущих обновлениях.

м. Шаблоны SMS и управление календарем бронирования:

• Список и получение: получение списка существующих шаблонов SMS и событий календаря бронирования или поиск конкретных.

Примечания:

• Для удобной идентификации и управления вашими токенами каждый из них должен иметь уникальное имя.
• Токен можно скопировать только сразу после его создания. Если вы забыли скопировать свой токен, удалите его и создайте новый.
• В целях безопасности мы будем отправлять вам уведомление по электронной почте всякий раз, когда в вашем аккаунте systeme.io создается новый публичный ключ API.
• Вы можете создать до 3 ключей API на одну учетную запись.

Подробнее: документация по API.