Вы находитесь на странице: 1из 9

API MonsterLeads v0.9.

- Авторизация происходит по параметру api_key который генерируется в разделе


профиль в кабинете.
- Для доступа к api параметр api_allow в настройках должен быть указан, как true
- URL куда приходят запросы:
Пример: http://api.monsterleads.pro/method/##МЕТОДА##?api_key=##КЛЮЧ##
- Для запроса доступны методы соединения GET и POST
- Лимит на соединения 1 запрос в секунду (в будущем будет пересматриваться)
- По умолчанию данные приходят в XML. Для получения результата в json добавьте в
конце запроса &format=json. Также возможно скачать данные в CSV, для этого
достаточно добавить &format=csv

Перечень кодов ошибок возвращаемых API

145 По данному офферу нет указанной цели

400 Неизвестная ошибка.


401 Авторизация не пройдена.
402 Такой метод не определен.
403 Обязательный параметр отсутствует.
404 Лид с таким ключом не существует.

405 Лид с таким ключом уже существует.


406 У вас нет доступа к этому элементу.
407 Холд данного заказа уже закончился, невозможно изменить статус

409 Поток не существует

438 Дубль номера телефона за последние 4 часа

439 Превышен лимит запросов (1 запрос в секунду)

Change log:
v0.8 Введена ошибка 407. Теперь заказ нельзя отменить если его холд истек.
v0.9 Метод order.edit заменен методом lead.edit
v0.9.1 Добавлен метод lead.list
v0.9.2 Добавлен метод order.add для роли вебмастеров.
v0.9.3 Параметр json=true, заменен на format=json, добавлена возможность качать в csv.
v0.9.4 Добавлены методы news.list и offers.list
v0.9.5 Добавлен метод call.history
v0.9.6 В методы order.add, lead.list добавлен параметр: traffic_type - тип трафика.
v0.9.7 Для метода order.add изменены ответы на дубль заказа и проблему с
авторизацией:
{"status":"error","error_code":"438","error_msg":"Дубль номера телефона за последние 4
часа."}
{"status":"error","error_code":"401","error_msg":"User authorization failed: invalid
api_key.","request_params":{"action":"order.add","api_key":"хххххххх","format":"json"}}
v0.9.8 Метод offers.list выводит список дополнительных товаров по каждой геоцели
Для метода order.add добавлен необязательный параметр product
v0.9.9 Для метода order.add добавлен необязательный параметр product_price, который
вместе с параметром product позволяет управлять ценами дополнительных товаров

Метод lead.list
Описание:
Данный метод генерирует список лидов.

Основные параметры:

api_key Ключ доступа

date_from Дата начала диапазона прим. 10.02.2014, по умолчанию понедельник тек.


недели

date_to Дата окончания диапазона прим. 17.02.2014, по умолчанию сегоднящний


день

status Тип выгружаемых лидов. Доступны значения all, review, approve,


paid, abort по умолчанию all

offset сдвиг начальной позиции при выводе лидов

itemppage по умолчанию 50 лидов за раз выводиться. минимум 1, максимум 200

lead_list hash заказов через запятую. прим. 2dsf23323d,43312dd2dss

(Внимание! Если вы передаете параметр(hash), добавьте в запрос


search_by=hash)
Необязательные параметры:

flow_code Фильтр по коду потока

sort если указать значением last, то даты будут игнорироваться. А лиды


выводиться в порядке от посл. изменений до самых старых
изменений в лиде.

update_from время от которого выводить обновления прим. 30.12.2013 13:01:01


не обязательный параметр. работает только при sort=last

Возвращаемые значения:
hash Идентификатор лида

data1...data5 Текстовые поля с информацией о лиде

cc_our Информация о КЦ ( 1 - КЦ Monsterleads, 2 КЦ рекламодателя )

status Статус лида ( 1 - ожидает, 2 - подтвержден, 3 - отменен )

lead_key Ключ лида

geo_name Название страны

geo_code Код страны

geo_id Идентификатор Geo

sum Сумма заказа. ( используется в товарных лидах)

profit Сумма отчислений

flow_name Название потока

flow_code Код потока

subid...subid5 Сабид

deeplink Ссылка на целевую страницу на сайте рекламодателя, куда


необходимо направить пользователя, например определенный
товар или категория

hold_days Кол-во дней холда по лиду

paid Состояние оплаты лида 0 - не ожидает оплаты, 1 - ожидает оплату, 2 -


оплачен, 3 - оплата отменена или возвращена

status статус лида 1 - ожидает, 2 - подтвержден, 3 - отклонен

paid оплата лида 0 - не ожидает оплаты, 1 - ожидает, 2 - оплата произведена, 3 -


оплата отклонена

target_complet Достигнута ли цель? true - да, false - нет


ed

add_date Дата добавления лида

complete_date Дата достижения цели

hold_end_date Дата завершения холда по лиду

offer_id ID оффера

offer_name Название программы лида

status_name Текстовое состояние лида review - ожидает, approved - подтвержден,


need_payment - нуждается в платеже, aborted - отменен

buyout Информация о выкупе: 0 - нет информации, 1 - выкуп, 2 - невыкуп

update_date дата изменения информации внутри лида. например смена статуса, или
изменение доп параметров

valid true/false Валидная/ невалидная(треш) причина отмены

cancel_reason Причина отмены 1- Не заказывал, 2- Нашел дешевле, 3- Не устр. дост., 4-


Hекорректные данные, 5- Дубль, 6- Неверное GEO, 7-Нету доставки в этот регион,
8- Консультация по товару, 9- Консультация по возврату, 10- Абонент недоступен
больше недели, 11- Изменение GEO, 12- Другая причина, 13- Консультация по
пред. заявке, 14 - Тест, 15- Дорого, 16 - Передумал, 17- Не предоставляет всех
данных для подтверждения, 18- не говорит по-русски, 19- Не поддерживаемое
GEO

traffic_type 0 - нет данных, 1 - мобильный, 2 - desktop

Метод order.add
Описание:
Данный метод эмулирует заказ на лендинге
!!Внимание!!
Перед использованием данного метода вы должны убедится что для данной цели по
указанному GEO он доступен. Для 100% корректности рекомендуем перед
использованием обратится в Support или к Вашему личному менеджеру.

Обязательные параметры:

api_key Ключ доступа

tel Номер телефона покупателя

ip ip адрес клиента

code Код потока прим. 8mjs856wu


Необязательные параметры:

geo geo-код страны прим. UA или RU, основные geo-коды вы можете посмотреть тут
- http://ru.wikipedia.org/wiki/ISO_3166-1 в cтолбце Alpha-2

client имя фамилия отчество клиента Это поле занимает ячейку инф #2

mail email покупателя прим. login@mail.ru

adress адрес доставки товара прим. Украина, Киев, ул. Грушевского 15, подьезд 2, кв 15

comments комментарий к заказу любое слово до 100 символов

shipping Информация о доставке любое слово до 20 символов

payment Информация о оплате любое слово до 20 символов

subid Субид привязывается к лиду. Если нужно добавить несколько subid


их стоит раздлелить символом “:” прим. subid=subid1:subid2:subid3
максимум 5 субид

foreign_value Внешний ид заказа

foreign_web_id Ид внешнего источника

product Идентификатор продукта, которым необходимо заменить основной


продукт. Если нужно добавить несколько продуктов, их стоит
разделить символом “:” прим. product=1234:1235:1236

product_price Цена дополнительного продукта. Работает вместе с параметром


product. Если нужно указать цену нескольким продуктам, их стоит
разделить символом “:”, указав в том же порядке, что и в параметре
product. прим. product_price=10:15:200

traffic_type 0 - нет данных, 1 - мобильный, 2 - desktop

Метод offers.list
Описание:
Данный метод выдает список офферов доступных указанному пользователю.
Параметры:

api_key Ключ доступа


Необязательные параметры:

language Язык отображения информации про офферы. Варианты: ru, en

Возвращаемые значения:

offer_id ид оффера

offer_desc Описание оффера

offer_name Название оффера

img_src Картинка оффера

sources Источники трафика

offer_url Ссылка на оффер в системе Monsterleads

target_id ID цели

target_name Название цели

target_geo Массив с гео-целями

-name Название гео цели

-profit Отчисления

-target_currency_code Валюта отчисления

-currency_code Валюта товара на лендинге

-charge Отчисления

-hold_time Время холда

- product Массив с дополнительными товарами

- product_id Идентификатор продукта

- product_name Наименование продукта

Метод news.list
Описание:
Данный метод дает возможность просмотреть новости персонально вебмастера или
все.

Параметры:
api_key Ключ доступа

type Тип новости. Доступно: all или my.


all - все,
my - только добавленных офферов вебмастера. По умолчанию All.

Возвращаемые значения

date дата добавления новости

topic заголовок новости

text текст новости

text_html текст новости с html тегами

offer_id ид оффера

offer_name название оффера

offer_image ссылка на картинку

Метод user.finance
Описание:
Данный метод возвращает информацию о текущем состоянии баланса пользователя.

Обязательные параметры:

api_key Ключ доступа

Возвращаемые значения:

current_balance текущий баланс пользователя

current_hold деньги находящиеся в холде

Метод offers.agregate
Описание:
Данный метод возвращает список офферов для агрегаторов

Возвращаемые значения:
offer_id ид оффера

offer_desc Описание оффера

offer_name Название оффера

img_src Картинка оффера

sources Источники трафика

offer_url Ссылка на оффер в системе Monsterleads

target_id ID цели

target_name Название цели

target_geo Массив с гео-целями

-name Название гео цели

-profit Отчисления

-currency_code Валюта

-charge Отчисления

-hold_time Время холда

landings Массив с леднингами

transits Массив с транзитными страницами

Метод call.history
Описание:
Данный метод выводит информацию о прозвоне заказов.

Обязательные параметры:

api_key Ключ доступа

Необязательные параметры:

date_from Дата начала диапазона прим. 10.02.2014

date_to Дата окончания диапазона прим. 17.02.2014

offset сдвиг начальной позиции при выводе


itemppage кол-во элементов на страницу. минимум 1, максимум 200

search_by Параметр, по которому ищем конкретные лиды. Принимаемые


значения: hash - (хеш лида) или lead_key (ключ лида). По умолчанию lead_key.
Передавать вместе с параметром lead_list..

lead_list Список лидов для поиска, через запятую. Например,


2c8609a5,2187b4a9,552cc7bb. Может принимать не более 5 значений. Передавать
вместе с параметром search_by.

Если указаны параметры search_by и lead_list, то даты будут проигнорированы.


Если даты не указаны, то выводятся заказы за последние 7 дней.

Возвращаемые значения:

lead_key ключ лида например, 19000003064961

hash hash лида например, 2c8609a5

status статус лида. 1 - ожидает, 2 - подтвержден, 3 - отклонен

logs История прозвона

-date Дата и время звонка например, 16.11.2016 13:31:13

-text Описание события например “Звонок абоненту”