API приёма лидов: что это в CPA-маркетинге
API позволяет отправлять заявки автоматически, не заходя в кабинет.
Что такое API приёма лидов
API приёма лидов — интерфейс, через который вебмастер отправляет заявки в сеть запросами: GET или POST. В «Лидпульте» используются адреса /api/lead и /site/apiaddlead/, поддерживаются плоские параметры и формат Lead[…]. Ключи вебмастера: wmkey (публичный) и apikey (секретный, показывается один раз, можно перевыпустить).
Полное описание параметров и кодов ответа — в документации API.
Пример
Ваша форма отправляет запрос с телефоном, именем, городом, оффером и уникальным apiid. Сеть проверяет ключ, статус вебмастера, оффер в работе, гео, телефон, лимит, дубль за 30 дней и свободные деньги клиники. В ответ приходит lead_id или код ошибки, например client_no_funds.
Нюансы
Повтор с тем же apiid возвращает тот же lead_id: это защищает от дублей при сбоях сети. Не храните apikey в клиентском коде страницы, отправляйте запросы с сервера.
Обрабатывайте коды ответов: при лимите или остановке по деньгам перенаправьте трафик или поставьте рекламу на паузу. Доставка клинике идёт со статусом «У клиента», Telegram-уведомлением и вебхуком в CRM, повторы — до 8 раз.
Как протестировать интеграцию
Отправьте тестовую заявку с корректным телефоном и убедитесь, что получили lead_id. Повторите запрос с тем же apiid и проверьте, что идентификатор не изменился. Попробуйте заведомо неверные данные и проверьте коды ошибок. Затем настройте постбэк и убедитесь, что статус приходит в трекер.
Связь с другими терминами
API использует постбэк для обратной связи, проверяет дубли и кап, принимает валидные лиды, работает с офферами. Метки передаются в sub-метках.
Вопросы и ответы
GET или POST?
Поддерживаются оба способа. Для надёжности и чувствительных данных предпочтительнее POST с сервера.
Что делать, если ключ скомпрометирован?
Перевыпустите apikey в кабинете и обновите его в своих скриптах.
Можно ли добавить заявку вручную?
Да, лид можно добавить вручную в кабинете.