Лидпульт

API: что это простыми словами

API — договорённость о том, как одна программа обращается к другой. В лидогенерации через API ваш сайт или трекер отправляет заявку в сеть без участия человека и получает ответ, принята она или нет.

Определение

API (интерфейс программирования приложений) — это набор адресов и правил: какой запрос отправить, какие параметры передать и в каком виде ждать ответ. Вам не нужно заходить в кабинет и вносить заявку руками: программа делает это сама, за доли секунды.

Как это выглядит в Лидпульте

Заявка отправляется запросом на адрес /api/lead или /site/apiaddlead/. Обязательные параметры: wmkey, apikey, offer_id, city, phone. В ответ приходит JSON: при успехе status: ok и номер lead_id, при отказе код причины. Полное описание есть на странице документации API.

Пример из практики

Вебмастер собрал заявки на своей форме. Сервер формы при каждой отправке обращается к API сети, передавая телефон, город и метки источника. Если ответ пришёл с кодом 200, форма показывает «Заявка принята». Если сеть вернула limit_reached, форма сообщает, что приём на сегодня закрыт, и вебмастер видит это в логах.

Нюансы

  • Секретный ключ нельзя вставлять в код, который виден посетителю сайта: запрос нужно отправлять с вашего сервера или из трекера.
  • Читайте не только HTTP-код, но и поле code в ответе: оно объясняет причину отказа.
  • Повторять запрос стоит только при ошибке сети и ответах 5xx; на 4xx повтор вернёт ту же ошибку.

Практический совет

Перед запуском трафика отправьте несколько тестовых запросов и убедитесь, что вы получаете понятные ответы на удачные и неудачные случаи. Сохраните примеры запросов в заметках: через месяц они сэкономят время при настройке нового оффера или смене трекера.

Связанные понятия

API обычно работает по принципу REST, данные передаются в формате JSON, а надёжность повторов обеспечивает идентификатор apiid. Обратный канал — вебхук или постбэк. Как это складывается в цепочку, показано на странице «Как это работает».

Вопросы и ответы

Нужно ли уметь программировать, чтобы работать через API?

Для простых случаев достаточно трекера: он сам подставляет параметры в адрес. Для собственной формы понадобится разработчик или готовый модуль.

Чем API отличается от ручной загрузки заявок?

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