API LeadPlan

Что можно #

• получить сайты аккаунта, код установки и состояние кода на сайте;
• смотреть виджеты, включать и выключать их;
• забирать заявки и данные посетителей, выгружать их в CSV, повторять доставку заявки;
• читать статистику показов, заявок и конверсии — по сайту, по виджетам, по A/B-тестам;
• настраивать вебхуки, на которые уходят заявки.

Вид и текст виджетов, A/B-тесты и тариф меняются только в кабинете. Все методы — в справочнике «Сайты и виджеты».

Ключ #

Кабинет LeadPlan → меню аккаунта → API. Выберите доступ к сайтам и к заявкам — чтение или изменение, при желании срок, и нажмите «Выпустить ключ». Скопируйте его сразу: второй раз он не покажется. Ключи выпускает владелец аккаунта.

Первый запрос #

Адрес API — https://api.leadplan.ru/v2, ключ — в заголовке Authorization:

curl 'https://api.leadplan.ru/v2/sites' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Ответ — список сайтов в конверте:

{
  "response": {
    "msg": {"err_code": 0, "text": "OK", "type": "message"},
    "data": [{"id": 100842, "name": "Магазин", "url": "example.ru", "status": "enabled", …}]
  }
}

id сайта нужен всем остальным методам: виджеты, заявки и статистика вложены в сайт — /sites/{site_id}/widgets, /sites/{site_id}/leads и так далее.

Формат #

• Тело запросов POST и PUT — JSON, заголовок Content-Type: application/json.
• Списки постраничные: limit и offset. Пустой список — "data": [], это не ошибка.
• Время — московское, YYYY-MM-DD HH:MM:SS.
• Заявки и посетители выгружаются файлом: ?format=csv.

Когда запрос не проходит #

Отказ приходит с HTTP-статусом и объектом error: в нём code — он точнее статуса — и текст. У кода 69 в details цифры лимита, у кода 67 — список полей с ошибками.

ИИ-ассистенты #

Claude, ChatGPT, Cursor и другие ассистенты работают с теми же данными без программирования — через MCP-сервер https://mcp.leadplan.ru/. Как подключить — на странице «Подключение ассистентов».