API (Application Programming Interface) — это инструмент, который позволяет вашим приложениям, сайтам, CRM "общаться" и обмениваться данными с платформой Leeloo.ai. C помощью API вы можете
получить информацию о ваших клиентах, передать данные о клиентах (офферах) в таблицу, подключить систему онлайн-оплаты или доставки, без сложной и затратной разработки is a tool that allows your applications, websites, and CRM to "communicate" and exchange data with the Leeloo.ai platform. With the API, you can retrieve information about your clients, send client data (offers) to a table, integrate online payment or delivery systems, without requiring complex or costly development.

Table of Contents

minLevel	1
maxLevel	6
outline	true
style	disc
type	list
printable	true

...

Introduction to API Usage

...

Headers

...

request

When making requests to Leeloo.AI вам необходимо использовать Headers, “+Заголовок запроса”
в “Ключ” вставьте , you need to use Headers. Add “Request Header” in “Key,” enter
X-Leeloo-AuthToken а в “Значение” ваш , and in “Value,” insert your Leeloo.ai API токен token.

Image Removed

...

Image Added

Where to Find the API Token?

API токен можно найти в разделе The API token can be found in the Leeloo.ai API на платформе Leeloo.ai. Он необходим для аутентификации запросов к API, подтверждая, что запросы исходят от авторизованного пользователя.

...

Типы запросов

На платформе доступны различные типы запросов, которые можно использовать для интеграции с внешними системами:

GET: для получения данных. Запрашивает информацию с API.
POST: для отправки данных. Отправляет данные (например, регистрация нового пользователя)
PUT: для обновления существующих данных.

...

Использование переменных и пользовательских полей

Переменные можно создавать в разделе Содержимое → Переменные
Пользовательские поля можно создавать в разделе Содержимое → Поля

Переменные и пользовательские поля можно вставлять в тело запроса (Body), если требуется динамическая передача данных. Например, если нужно передать данные о пользователе или статусе заказа, вставляйте переменные в поля запроса для передачи индивидуальной информации.

Image Removed

Список системных ID (переменных), доступных в платформе:

...

section on the platform. It is necessary for authenticating requests to the API, confirming that requests come from an authorized user.

...

Types of Requests

The platform provides various types of requests that can be used for integration with external systems:

GET: to retrieve data. Requests information from the API
POST: to submit data (e.g., registering a new user).
PUT: to update existing data.

...

Using Variables and Custom Fields

Variables can be created in Content → Variables.
Custom fields can be created in Content → Fields.

You can insert variables and custom fields into the request body if dynamic data transfer is required. For example, to send user or order status information, include variables in the request fields for transmitting individual information.

Image Added

List of System IDs (Variables) Available on the Platform:

category_id - the ID of the message template category. This category_id is found in the URL when opening the template category in Sales Funnels, Message Templates.
Example - https://app.leeloo.ai/campaigns-templates/category_id/templates
account_id - id канала связи берем из сылки в карте клиента в раздел Чаты.
Пример the ID from the client card in the Chats section.
Example - https://app.leeloo.ai/chats/unread/account_id/5e60191da0fd4a000d3998bc/
template_id - id шаблона сообщения на платформе берем из шаблона сообщения созданного в категории шаблонов.
Пример the message template ID on the platform, available from the message template created in the template category.
Example - https://app.leeloo.ai/campaigns-templates/category_id/templates/creator/template_id
person_id - id канала коммуникации берем из ссылки клиента в разделе Чаты.
Пример the communication channel ID found in the client link in Chats.
Example - https://app.leeloo.ai/chats/all/account_id/person_id
leadgentool_id - id Инструмента Лидогенерации (LGT) берем из туннеля продаж, вашего уже созданного ЛГТ. Нажмите правой кнопкой миши по нему, затем “Скопировать ID LGT”paymentCreditsId - id платежной системы. Можно узнать в настройках платформы, разделе Платежи нажав “Подробнее” на подключенном платеже
Пример the ID of the Lead Generation Tool (LGT) from your created LGT in the sales funnel. Right-click on it, then “Copy LGT ID”
paymentCreditsId - the payment system ID. You can find it in the platform settings under Payments by clicking “Details” on the connected payment.
Example - https://app.leeloo.ai/settings/integrations/payments/credits/payment-credit/manual/paymentCreditsId
offerId - id Предложения берем из созданного вами Оффера (Предложения) разделе Туннеле Продаж.
Пример the Offer ID taken from the Offers you created in the Sales Funnel section.
Example - https://app.leeloo.ai/campaigns-offers/offerId/offers/1
managerId - id менеджера the manager (Пользователя) которого вы добавили в платформу через раздел Пользователи нажмите на созданного позьвателя и скопируйте id в ссылке.
Пример user) ID added to the platform through the Users section. Click on the created user and copy the ID from the link.
Example - https://app.leeloo.ai/settings/company/users/user/managerId
order_id - id заказа тоесть когда ваш оффер перешел в статус заказа. Этот id можно взять выполнив запрос Получить Список Ордеров где в ответе будет иформация про заказ в том числе id заказа.
Пример the order ID, which is generated when your offer changes to an order status. This ID can be obtained by performing the “Get Order List” request, which includes information about the order, including the order ID.
Example - "{"data":[{"id":"order_id","person_id":"person_i","title":"Курс9","price":20,"currency":"USD","status":"REJECTED","createdAt":"2024-10-03T08:00:02.853Z","updatedAt":"2024-10-03T15:25:49.028Z"},
user_id - id пользователя (Подписчика) именно аудитории. Получить можно выполнив запрос Получить Список Пользователей Платформы где в ответе будет информация про id пользователя
Пример Example - "{"data":{"id":"user_id","name":"Andrew","createdAt":"2024-02-21T12:32:55.085Z","updatedAt":"2024-10-07T06:42:52.631Z"},"status":1}"
tunnel_id - id туннеля продаж. Получить можно перейдя в ваш туннель продаж скопировав из адресно строки
Пример Example - https://app.leeloo.ai/tunnels/tunnel_id/tree
tunnel_block_id - id блока в туннеле продаж. Получить можно перейдя в ваш туннель продаж, нажав на блок, скопировав из адресно строки
Пример Example - https://app.leeloo.ai/tunnels/tunnel_id/tree/tunnel_block_id
connection_id - id канала связи. Получить можно выполнив запрос на получение информации о пользователях, или конкретном пользователе. Напримере НаExampleе запроса Получить Информацию по Конкретному Человеку
Пример Example -
{
"account_id": "account_id",
"connection_id": "connection_id",
"connection_status": "OK",
"from": "TELEGRAM"
}
tag_id - id Тега который мы присваиваем пользователям (подписчикам). Получить можно перейдя в Настройки плайтформы, раздел Настройки CRM, Тегинажав “Скопировать ID” правее от созданного Тега.

...

Path Params
category_id (example: 5b3f543bb2737000133d25b0) - id категории шаблонов сообщений
Этот category_id берем из ссылки при открытии категории шаблона в разделе Туннели продаж, Шаблоны сообщений.
ПримерExample: https://app.leeloo.ai/campaigns-templates/categoty_id/templates

...

Request Body(json)
account_id (example: 513f543gb2737020133d25b0) - id канала связи берем из сылки в карте клиента в раздел чаты. ПримерExample: https://app.leeloo.ai/chats/unread/account_id/5e60191da0fd4a000d3998bc/
template_id (example: 6b3f543bb2737003133d25b4) - id шаблона сообщения на платформе

...

Path Params
person_id (example: 5b3f543bb2737000133d25b0) - id канала коммуникации берем из ссылки клиента в разделе Чаты. Пример Example https://app.leeloo.ai/chats/all/66fac2b853d5470e1ed207b6/person_id

...

Code Block

{
    "data": [
          {
          "id": "5e3bf8d6c6ed91000c8534ae",
          "text": "Test API v.1 message template",
          "type": "YOUR_MESSAGE",
          "read": true,
          "createdAt": "2020-02-06T11:30:30.035Z",
          "updatedAt": "2020-02-06T11:30:30.035Z"
          },
          {
          "id": "5e3beba47fa862000e3b4d05",
          "text": "API message",
          "type": "YOUR_MESSAGE",
          "read": true,
          "createdAt": "2020-02-06T10:34:12.230Z",
          "updatedAt": "2020-02-06T10:34:12.230Z"
          }
    ],
    "meta": {
          "limit": 3,
          "offset": 0,
          "filteredCount": 3,
          "totalCount": 52
    },
    "status": 1
}

Info
ВАЖНО! Пример Example ответа на запрос показан для установленого параметра лимита равного двум. При изменении значения параметра лимита будет изменяться и кол-во сообщений в ответе на запрос.

...

Versions Compared

Old Version 1

New Version 2

Key

Introduction to API Usage

Headers

request

Where to Find the API Token?

Типы запросов

Использование переменных и пользовательских полей

Список системных ID (переменных), доступных в платформе:

Types of Requests

Using Variables and Custom Fields

List of System IDs (Variables) Available on the Platform:

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

Introduction to API Usage

Headers

request

Where to Find the API Token?

Типы запросов

Использование переменных и пользовательских полей

Список системных ID (переменных), доступных в платформе:

Types of Requests

Using Variables and Custom Fields

List of System IDs (Variables) Available on the Platform: