Документация API LPgenereator
API — это интерфейс для разработчиков, который позволяет управлять своим аккаунтом внутри сервиса.
На данный момент API представлен только функцией добавления лида в CRM.
Функция добавления лида
Вызов функции осуществляется посредством HTTP запроса с передачей необходимых GET параметров. Все параметры должны иметь кодировку UTF-8.
URL:
http://lpgenerator.ru/api/leads/add/?api_key=API_KEY&variant=VARIANT_ID¬ify=NOTIFY&channel=CHANNEL&ПОЛЕ1=ЗНАЧЕНИЕ1&ПОЛЕ2=ЗНАЧЕНИЕ2
Где:
API_KEY | Обязательный | Ваш уникальный ключ. Доступен в личном кабинете. |
VARIANT_ID | Обязательный | ID варианта, на который передается лид. Обратите внимание, что ID страницы и ID варианта отличаются. |
NOTIFY | Опциональный по умолчанию пустой |
Если значение равно 1, то после добавления лида владелец получит оповещение на email. |
CHANNEL | Опциональный по умолчанию пустой |
Параметр источника трафика. Если параметр передан неверно, он будет проигнорирован. |
ПОЛЕ1=ЗНАЧЕНИЕ1 | Обязательный | Любое количество данных лида. Данные должны передаваться в связке field=value («поле=значение»). Указанные поля будут записаны в данные лида as is, независимо от заданных в форме варианта полей (у варианта вообще может не быть формы). |
Пример рабочего запроса:
http://lpgenerator.ru/api/leads/add/?api_key=aaaaaaaaa&variant=1¬ify=1&channel=fb&имя=Николй&email=test@test.com&телефон=12345
Ответ приходит в формате JSON.
Успешный вызов
В случае успешного вызова, ответ будет содержать поле «success» со значением «ok».
Пример успешного вызова:
{"success": "ok"}
Неудачный вызов.
В случае неудачного вызова, ответ будет содержать поле «error» со значением ошибки.
Пример неудачного вызова:
{"error": "Invalid api key"}
Пиксель
Для удобства, вы можете воспользоваться пикселем добавления лида. Его необходимо разместить на странице благодарности и передать все необходимые параметры.
Пиксель отличается адресом вызова. Так же он не возвращает ничего в ответ, то есть вам не придется заботится об обработке ошибок.
URL для пикселя:
http://lpgenerator.ru/api/leads/add/pixel и все параметры описанные выше.
Пример пикселя:
<iframe src="http://lpgenerator.ru/api/leads/add/pixel/?api_key=aaaaaaaaa&variant=1¬ify=1&channel=fb&имя=Николй&email=test@test.com&телефон=12345" scrolling="no" frameborder="0" width="1" height="1">
Для вашего удобства, мы создали генератор кода для пикселя.
Примеры работы с API
Python
import urllib
import json
data = {
u'api_key': 'aaaaaaaaa',
u'notify': '',
u'channel': '',
u'variant': 1,
u'Field1': u'Value1',
u'Поле2'.encode('utf-8'): u'Значение2'.encode('utf-8'),
}
url = u'http://lpgenerator.ru/api/leads/add/?%s' % urllib.urlencode(data)
try:
result = json.load(urllib.urlopen(url))
except Exception as e:
print 'Error', e
else:
if result.get('success'):
print 'Success'
else:
print 'Error', result.get('error', 'Unknown error')
PHP
<?php
$data = array(
'api_key' => 'aaaaaaaaa',
'notify' => '',
'channel' => '',
'variant' => 1,
'Field1' => 'Value1',
'Поле2' => 'Значение2',
);
$url = 'http://lpgenerator.ru/api/leads/add/?' . http_build_query($data);
$result = json_decode(fread(fopen($url, 'r'), 1024), TRUE);
if (isset($result['success'])) {
echo 'Success';
} else {
echo 'Error: ' . $result['error'];
}
?>