С помощью API на запись в Leeloo.ai доступны следующие действия:

Работа с клиентами

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

Отправка сообщения

Отправляйте вашим клиентам сообщение с помощью API. Для этого отправьте запрос:

POST: https://api.leeloo.ai/api/v1/messages/send-message

В body запроса поместите:

{"text": "API message",
"account_id": "id"
}

где API message - текст сообщения. Введите сообщение, которое вы хотите отправить клиенту
id - идентификатор аккаунта клиента.

В Content type укажите: application/json,
Upload data type: String data.

Пример тела запроса:

   {
        "text": "API message",
        "account_id": "5a6e6281be5183684a173ebc"
    }

Отправка шаблона сообщения

Отправляйте вашим клиентам сообщение в виде шаблона сообщения, которое есть в вашей компании на платформе. Для этого:

1. Получите список категорий шаблонов сообщений

Отправьте запрос GET: https://api.leeloo.ai/api/v1/categories/templates

Пример ответа

{
  "data": {
    "categories": [
      {
        "id": "59d8e2bed337f2017f4ed152",
        "name": "МЛМ туннель"
      },
      {
        "id": "59d5479fdd70a50140a677d0",
        "name": "Запуск"
      },
      {
        "id": "59ccf357221f2f008f0eceab",
        "name": "АТПвМ 22.07.2017"
      }
    ]
  },
  "status": 1
}

2. Получите список шаблонов сообщений в категории

Отправьте запрос GET: https://api.leeloo.ai/api/v1/categories/templates/category_id,

где category_id - id категории шаблонов сообщений.

Пример запроса: https://api.leeloo.ai/api/v1/categories/templates/5a4e52b53febb400282f2645

Пример ответа

{
  "data": {
    "templates": [
      {
        "id": "5a4e52b53febb400282f2644",
        "message_name": "180к видео"
      }
    ]
  },
  "status": 1
}

3. Отправьте шаблон сообщения

Отправьте запрос POST: https://api.leeloo.ai/api/v1/messages/send-template

В body запроса поместите:

{"template_id": "id шаблона сообщения", 
"account_id": "id аккаунта клиента"
}

Пример тела запроса

{"template_id": "5a4e52b53febb400282f2644",
"account_id": "5a6e6281be5183684a173ebc"
}

Добавление комментария

Добавляйте вашим клиентам комментарий в карту клиента через API. Для этого отправьте запрос:

PUT: https://api.leeloo.ai/api/v1/accounts/account_id/set-comment,

где account_id - id аккаунта клиента

В body запроса поместите:

{"comment": "comment_text"}

где comment_text - текст комментария. Впишите сюда комментарий, который вы хотите добавить клиенту.

Присваивание тега

Присваивайте вашим клиентам тег через API. Для этого:

Получите список тегов:
Отправьте запрос GET: https://api.leeloo.ai/api/v1/tags
Присвойте тег
Отправьте запрос PUT: https://api.leeloo.ai/api/v1/accounts/account_id/add-tag

где account_id - id аккаунта клиента

В body запроса поместите:

{"tag_id": "id"}

где, id - идентификатор тега. Здесь укажите идентификатор одного из тегов, которые вы получили в списке на шаге 1 и хотите присвоить клиенту.

Работа с заказами

Создавайте новый аккаунт, если оплатившего ещё нет в CRM платформы, добавляйте в систему заказы, присваивая их конкретным клиентам, обновляйте статус заказа, цену, валюту, комментарий через API.

Создание аккаунта

Если оплата заказа была осуществлена в другом сервисе и покупателя нет среди клиентов в CRM платформы, создайте новый аккаунт через API и впоследствии присвойте ему оплату.

Отправьте запрос POST: https://api.leeloo.ai/api/v1/accounts

В body запроса поместите:

{"name": "Account_name",
"email": "mail@mail.com",
"phone": "+380987654321"}

Все параметры обязательны.

В Content type укажите: application/json,
Upload data type: String data.

Аккаунту, созданному через API не удастся отправить сообщение. Он будет служить больше для учета аналитики

В header запроса X-Leeloo-AuthToken поместите токен авторизации.

Пример ответа сервера:

{
  "data": {
    "id": "5b605a0eda671200387955fb",
    "name": "Created with API",
    "tags": [],
    "from": "MANUAL",
    "botStatus": "BOT",
    "connectionStatus": "OK",
    "gender": "NOT_DEFINED",
    "phone": "+380988738352",
    "email": "mail@mail.com",
    "locale": "",
    "subscribeHistory": [],
    "createdAt": "2018-07-31T12:46:06.586Z",
    "updatedAt": "2018-07-31T12:46:06.586Z"
  },
  "status": 1
}

Добавление заказа

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

Отправьте запрос POST: https://api.leeloo.ai/api/v1/orders

В body запроса поместите:

{"paymentCreditsId": "5b0d313b307879002915b3cc",
"email": "mail@mail.com",
"phone": "+380987654321",
"transactionDate": "2018-06-27 07:32",
"offerId": "5b0d316e307879002915b3cd",
"accountId": "5aa7dc70839951003a597aa9",
"isNotifyAccount": "false"
}

где:

paymentCreditsId - идентификатор платежной системы. Вы можете узнать его в настройках системы для проведения ручных оплат, в поле "Идентификатор для вызовов API":

Нужен идентфикикатор системы для проведения именно ручных платежей. Поэтому в настройках обычной платежной системы не будет поля "Идентификатор для вызовов API".
email - email покупателя;
phone - номер телефона покупателя;
transactionDate - дата проведения транзакции в формате ГГГГ-ММ-ДД ЧЧ:ММ в часовом поясе GMT+0. Эта дата будет фигурировать в дате счета (платежа). В самом заказе будет указана текущая дата (на момент выполенения запроса);
offerId - идентификатор оффера. Его вы можете узнать в адресной строке браузера открыв конструктор Вашего оффера:
accountId - идентификатор клиента в платформе. Его вы можете узнать:
- если клиент уже существует в системе - кликнув на имя клиента в чате. В адресной строке он будет распологаться между "important/" и "/user-card":
- если новый клиент только создан через API - из ответа сервера (поле "id")
- если клиента ещё нет в системе - создайте его с помощью метода "Создание аккаунта".
isNotifyAccount - отправлять ли клиенту в мессенджер сообщение благодарности за покупку:
- true - отправлять;
- faulse - не отправлять

Все параметры в body запроса обязательны к заполнению.

В header запроса X-Leeloo-AuthToken поместите токен авторизации.

Пример ответа:

{
  "data": {
    "id": "5b605a6deba7f100241122e2",
    "title": "Test",
    "price": 2,
    "currency": "USD",
    "status": "OPENED",
    "createdAt": "2018-07-31T12:47:41.771Z",
    "updatedAt": "2018-07-31T12:47:41.771Z"
  },
  "status": 1
}

Обновление заказа

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

Отправьте запрос POST: https://api.leeloo.ai/api/v1/orders/order_id

где, order_id - идентификатор заказа в системе.

Пример запроса:

https://api.leeloo.ai/api/v1/orders/5b605470da671200387955f7

Идентификатор заказа вы можете получить:

а) сделав запрос на получение списка всех заказов:

GET: https://api.leeloo.ai/api/v1/orders (подробнее);

б) взяв из ответа сервера при добавлении заказа через API.

В body запроса поместите:

{"status": "RESOLVED",
"paymentDate": "2018-06-27 07:32",
"currency": "RUB",
"price": "100",
"userComments": "actual date dont match"
}

где:

status - статус заказа:
- RESOLVED - успешен;
- REJECTED - провален;
paymentDate - дата оплаты в формате ГГГГ-ММ-ДД ЧЧ:ММ в часовом поясе GMT+0;
currency - валюта платежа. Введите код валюты, которая доступна в вашей компании. Подробнее о валютах компании.
price - сумма оплаты, которая получена от клиента;
userComments - комментарий к платежу (комментарий менеджера);

Все параметры в body запроса, кроме userComments, обязательны к заполнению.

В header запроса X-Leeloo-AuthToken поместите токен авторизации.

Документация Leeloo.ai

Write API

Работа с клиентами

Отправка сообщения

Отправка шаблона сообщения

Добавление комментария

Присваивание тега

Работа с заказами

Создание аккаунта

Добавление заказа

Обновление заказа