MelioraAPI
Ранний доступ. Ключи выдаются по запросу. Как получить ключ

API Meliora

Читайте кампании, лиды, сохраненную переписку и события вашего кабинета Meliora из CRM или своей системы. Версия v1, ранний доступ.

Первый запрос за 5 минутСправочник API

Запрос
curl https://api.melioralab.io/v1/me \
  -H "Authorization: Bearer $MELIORA_API_KEY"
Ответ, сокращенно
{
  "object": "api_context",
  "organization": {
    "id": "2c8f4a61-7d3e-4b9a-8f21-6a0d5e9c3b17",
    "name": "Пример"
  },
  "scopes": [
    "campaigns:read",
    "events:read",
    "leads:read",
    "messages:read"
  ],
  "api_version": "v1"
}

#Что можно сделать

API отдает данные кабинета в JSON по ключу организации. Типичные задачи:

  • Связать ответы с CRM. Лента событий сообщает о первом сообщении лиду и о его ответе, а поле fields.record_id в карточке лида связывает его с записью CRM.
  • Показать прогресс кампаний. Статусы кампаний и лидов, состояние доставки и причина ожидания: например, окно отправки или дневная норма аккаунта.
  • Забрать переписку. Сохраненные сообщения с лидом: шаги цепочки, ручные сообщения менеджеров и ответы.
  • Сверить данные. Списки кампаний и лидов с фильтрами по пространству, кампании, статусу и нику.

#Маршруты

Все маршруты в v1 только читают данные, метод GET.

МаршрутЧто возвращаетПраво
GET /v1/meПолучить сведения о ключелюбое
GET /v1/workspacesСписок пространствлюбое
GET /v1/campaignsСписок кампанийcampaigns:read
GET /v1/campaigns/{id}Получить кампаниюcampaigns:read
GET /v1/leadsСписок лидовleads:read
GET /v1/leads/{id}Получить лидаleads:read
GET /v1/leads/{id}/messagesПереписка с лидомmessages:read
GET /v1/eventsЛента событийevents:read

#Как устроен API

  • Базовый адрес: https://api.melioralab.io/v1.
  • Ключ передается в заголовке Authorization: Bearer mel_live_.... Ключ принадлежит кабинету, а не сотруднику, и продолжает работать, если создавший его сотрудник ушел.
  • Ответы в JSON UTF-8, имена полей в snake_case, идентификаторы в формате UUID, время в ISO 8601 по UTC с суффиксом Z.
  • Ключ видит только то, что разрешено его правами и охватом. Объект вне охвата для ключа не существует и дает 404.
  • Запросы выполняются с вашего сервера. Браузерные запросы с чужих сайтов не поддерживаются.

#Ранний доступ

API находится в раннем доступе. Раздел ключей в кабинете открывается по запросу: напишите в поддержку, и мы подключим ваш кабинет. Чтение доступно на тарифе Pro и выше.

Что важно знать заранее:

  • Только чтение. Принять контакты, запустить или остановить цепочку через API пока нельзя. Это делается в кабинете.
  • Архив переписки может быть неполным. API отдает то, что сохранено. Полнота указана в meta.completeness.
  • Лента хранит события 30 дней. Опрашивайте ее регулярно, а после долгого простоя сверяйте карточки по инструкции из руководства Опрос событий.
  • Часть значений статусов пока не приходит. Подробности в руководстве Статусы лида и доставки.

#С чего начать

  1. Быстрый старт: первый запрос за 5 минут.
  2. Аутентификация и ключи: права, охват, ротация и отзыв.
  3. Опрос событий: надежный цикл для интеграции с CRM.
  4. Справочник API: все поля, параметры и примеры ответов.

Спецификация в формате OpenAPI 3.1 доступна для скачивания: openapi.json. Ее можно импортировать в Postman, Insomnia или генератор клиентов.