API Keys

Створення та управління API-ключами, scopes, довідка по REST API ендпоінтах.

API Keys

API Keys дозволяють зовнішнім системам взаємодіяти з платформою через REST API. Розташування: Settings → DEVELOPER → API Keys.

Сервер: https://sprootal.com/api/v1

Автентифікація: Bearer Token у форматі lg_live_xxx (Live) або lg_test_xxx (Test)

Створення API Key

  1. Натисніть Create API Key
  2. Введіть Name
  3. Виберіть Type: Live (продакшн) або Test (розробка)
  4. Виберіть Scopes
  5. Натисніть Create Key
Ключ показується лише один раз після створення — збережіть його одразу.

Доступні Scopes

ГрупаScopes
Contacts & MessagingRead / Write Contacts · Read / Write Messages
OrganizationRead / Write Projects · Read / Write Lists · Read / Write Tags
Pipeline & TasksRead / Write Pipelines · Read / Write Tasks
AutomationsRead / Write Automations
Companies & AnalyticsRead / Write Companies · Read Analytics
SettingsRead / Write Sender Profiles · Manage Webhooks

Ресурси API

Contacts

МетодЕндпоінтОпис
GET/contactsСписок контактів
GET/contacts/searchРозширений пошук
POST/contactsСтворити контакт
GET/contacts/{id}Деталі контакту
PUT/contacts/{id}Оновити контакт
DELETE/contacts/{id}Видалити контакт

Automations

МетодЕндпоінтОпис
GET/automationsСписок автоматизацій
GET/automations/{id}Деталі автоматизації
POST/automations/{id}/enrollДодати контакти
POST/automations/{id}/unenrollВидалити контакти
PUT/automations/{id}/statusПризупинити або відновити

Управління ключами

ДіяОпис
Rotate KeyЗгенерувати новий токен — старий перестане працювати
Revoke KeyПовністю видалити ключ

Часті питання

Скільки API ключів можна створити?

Обмежень немає. Рекомендується створювати окремий ключ для кожної інтеграції.

Яка різниця між Live і Test ключем?

Test ключ для розробки — працює з тими самими даними, але безпечно для тестування. Live ключ для продакшну.