Як використовувати публічний API systeme.io (Інтерфейс програмування додатків)

У цій статті ви дізнаєтеся, як налаштовувати та використовувати systeme.io публічний API, включаючи те, як згенерувати API ключі та які дії ви можете виконувати.

1. Що таке API?

Абревіатура API означає "Інтерфейс програмування додатків", що є серією інструкцій, за допомогою яких одна платформа надає послуги іншим платформам. Це стратегічний шлюз для зовнішніх розробників, дозволяючи їм отримувати доступ до конкретної функціональності або даних платформи у структурованому, безпечному вигляді. Це як набір готових до використання інструментів, які полегшують створення нових додатків, сервісів або комбінацій.

Отже, systeme.io відкривається для інших платформ, щоб пропонувати свої послуги, де вони мають додаткову цінність.

2. Як працює наш публічний API?

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

3. Як згенерувати ваші ключі API

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

Щоб створити публічний ключ API, натисніть на ваше зображення профілю, виберіть Налаштування (1) і прокрутіть вниз до MCP & API ключі (2).

Натисніть Створити (3), щоб почати створення публічного ключа API.

У спливаючому вікні Створення публічного ключа API введіть назву та виберіть дату і час закінчення терміну дії для вашого API ключа.

Після цього натисніть Зберегти (4).

Тепер ваш ключ готовий.

4. Що ви можете робити з нашим API?

Наш API відкриває цікаві можливості. Нижче наведено основні дії, які ви можете виконувати за допомогою нашого публічного API:

a. Контакти, теги та користувацькі поля:

• Керування контактами: Створення нових контактів, оновлення існуючих, перелік вашої аудиторії з розширеними фільтрами або видалення контактів.
• Керування тегами: Створення, призначення, перелік та видалення тегів з контактів.
• Користувацькі поля: Отримання доступних контактних користувацьких полів та їх ідентифікаторів (слагів) для правильного заповнення контактної інформації.

b. Розсилки:

• Створення та оновлення розсилок: Створення нових чернеток розсилок або часткове оновлення існуючих. Ви можете визначити тип редактора (Класичний або Візуальний), отримати повний HTML-контент та явно встановити ім’я та електронну адресу відправника.
• Перелік та отримання: Перегляд існуючих розсилок або отримання повного контенту конкретної розсилки, використовуючи її ID.

c. Воронки та редактор сторінок:

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

d. Плани цін і купони:

• Створення, редагування та видалення: Генерація нових планів цін та купонів, або часткове оновлення та видалення існуючих.
• Перелік та пошук: Перелічення всіх ваших існуючих планів цін та купонів, або отримання конкретних елементів за їх ID.

e. Курси та студенти:

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

f. Спільноти:

• Керування спільнотами: Отримання списку ваших існуючих спільнот та доступу до списку поточних учасників у конкретній спільноті.
• Запрошення учасників: Програмне запрошення нових користувачів приєднатися до ваших спільнот, надаючи їхній ID контакту.

g. Правила автоматизації:

• Керування правилами: Програмний зв'язок загальних подій та дій, оновлення існуючих правил (наприклад, зміна дії при збереженні тригера), або умовне видалення правил.
• Перелік та отримання: Перегляд ваших правил автоматизації або отримання конкретного правила за його ID.

h. Підписки:

• Керування підписками: Отримання списку всіх ресурсів у підписці з платформ третіх сторін, та скасування підписки негайно або у кінці розрахункового періоду.

i. Вебгуки

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

Дізнайтеся більше: Документація API.