Описание параметров для работы с api



Дата08.06.2016
Размер97.3 Kb.




E-mail:

Сайт:


info@mixmarket.biz

http://mixmarket.biz





Документация по API

агрегатора партнерских

программ Микс-Юни

Дата последнего редактирования



19 сентября 2014 г.
Лог изменений:

17 февраля 2010 года – первая редакция.

16 марта 2010 года – добавлены параметры period=custom, date_from=yyyy-mm-dd и date_to=yyyy-mm-dd для выборки отчета по датам.

3 июля 2012 года – добавлено: параметр sub_id; описание всех дополнительных параметров для сегментации трафика; исправлен параметр "stat id" на stat_id и для него введен новый формат отображения информации.

19 сентября 2014 года – добавлено: параметры status, hold_price, order_price


Описание параметров для работы с API. 2

Сегментация и управления трафиком. 2

Пример работы с API 3

Получение списка партнерских программ 3

Подключение к партнерской программе 5

Получение рекламной ссылки и рекламных материалов 5

Работа с отчетами по кликам и событиям 7



Описание параметров для работы с API.


Для доступа к API необходимо отправить GET/POST-запрос к скрипту http://mixmarket.biz/uni/api.php с указанием:

  • id – идентификатор рекламной площадки в рамках Микс-Юни;

  • pass – пароль для доступа, который является уникальным для каждой рекламной площадки и не связан с основным логином и паролем для доступа в личный кабинет партнера;

  • e – действие, которое нужно выполнить:

    • programslist – XML-отчет со списком доступных программ;

    • materialslist – XML-отчет со списком доступных рекламных материалов;

    • joinprogram – запрос на подключение к партнерской программе;

    • clicksreport – XML-отчет по кликам с рекламной площадки;

    • eventsreport – XML-отчет по событиям с рекламной площадки.

А также доступны дополнительные параметры запроса:



  • type – ID типа рекламного материала при запросе materialslist;

  • width – точная ширина рекламного материала (доступна только для materialslist и графических рекламных материалов: баннер и flash-баннер)

  • height - точная высота рекламного материала (доступна только для materialslist и графических рекламных материалов: баннер и flash-баннер)

  • program_id – ID программы для joinprogram и materialslist;

  • period – период отчета для clicksreport и eventsreport. Можно использовать: day (за сегодня, параметр по умолчанию); week (7 дней, не включая сегодня); month (31 день, не включая сегодня) или period=custom (для индивидуальной выборки, максимальный диапазон – 30 дней)

  • date_from - начальная дата для отчета для clicksreport и eventsreport при указании period=custom

  • date_to - конечная дата для отчета для clicksreport и eventsreport при указании period=custom

  • zip – zip=1 передать отчет в формате .gz для clicksreport и eventsreport.


Сегментация и управления трафиком.

Сегментация трафика производиться двумя параметрами:



  • sub_id – любые латинские буквы и цифры с максимальной длиной 255 символов;

  • stat_id – цифровое значение в диапозоне от 1 до 4 294 967 295 (4 миллиардов!).

В дальнейшем данные sub_id и stat_id будут передаваться в событийном отчете.
Для управления трафиком можно использовать параметр "redir", который позволяет отправить посетителя на нужную целевую страницу.

Внимание: В некоторых партнерских программах жестко указана целевая страница, поэтому Микс-Юни будет игнорировать любые попытки переназначения целевой страницу. Для таких ссылок система выдаст ссылку с параметром redir=1



Пример работы с API


Получение списка партнерских программ

Для получения списка партнерских программ необходимо сформировать запрос в виде http://mixmarket.biz/uni/api.php?id=xxx&pass=xxx&e=programslist.

В ответе будет XML-файл в формате:







Интернет-услуги

Партнерские сети




Привлечение участников в Партнерскую сеть Миксмаркет



n/a

n/a



рабочий

18

В первую очередь рады площадкам с вебмастерской, а также с клиентской аудиторией.

RUR





Рекламодатель зарегистрировался

1 руб.







Партнер зарегистрировался

0.5 руб.







Одобрение регистрации рекламодателя в Микс-Товары

150 руб.







Рекламодатель начал работать в Микс-Юни

650 руб.







Рекламодатель начал работать в Микс-Товары

500 руб.







Периодические выплаты с заработка партнера

1%

5%










7

8

13

11






где:

- список всех категорий партнерских программ;

- категория;

- список доступных программ;

- описание конкретной программы;

- название программы; <br /> <br /><epc> - доход на 100 кликов: global – глобальный по системе; current – рекламной площадки; <br /> <br /><stat id='XXX'> - epc по номеру среза, который задает рекламная площадка. Номер среза может быть только цифровой в диапазоне от 1 до 4 294 967 295; <br /> <br /><status id="X"> - статус рекламной площадке в программе. Возможные статусы </p> <p>0 => 'в рассмотрении',</p> <p>2 => 'отключена рекламодателем', </p> <p>3 => 'отключена мной',</p> <p>4 => 'рабочий', </p> <p>5 => 'рекламодатель отклонил заявку',</p> <p>7 => 'рекламодатель отключен системой', </p> <p>8 => 'заявка отклонена мной',</p> <p>9 => 'рассматривается мной', </p> <p>10 => 'повторная заявка рекламодателю',</p> <p>11 => 'запрещено работать в ПДП', </p> <p>12 => 'программа взаимоисключена'</p> <br /> <br /><requirements> - требования рекламодателя к рекламных площадкам; <br /> <br /><currency> - валюта партнерской программы; <br /> <br /><conditions> - условия программы <br /> <br /><condition> - описание конкретного условия с <a href="/58-ot-03-07-2015-g-sostav-uchreditelej-npf-apk-fond-i-inih-lic.html">указанием названия условия и размера</a> партнерского вознаграждения <br /> <br /><price> - вознаграждение партнера, в случае, если это фиксированный процент или фиксированная сумма <br /> <br /><price_from> и <price_to> - вознаграждение партнера, если по условиям программы задана плавающая ставка комиссии. <br /><advmaterials> - список доступных рекламных материалов с указанием ID типа, названия и количества рекламных материалов. <br /> <br /><geotarget id="YYY" factor="N"/> - список регионов геотаргетинга и коэффициент наценки. <p> <b>Подключение к партнерской программе</b></p> <p>Для получения списка партнерских программ необходимо сформировать запрос в виде http://mixmarket.biz/uni/api.php?id=xxx&pass=xxx&e=joinprogram&program_id=XX </p> <p>В <a href="/reshenie-ishodnoe-uravnenie-ekvivalentno-uravneniyu-gde-i-polu.html">ответ будет отправлен ответ </a></p> <br /> <br /><?xml version='1.0' encoding='windows-1251'?> <br /> <br /><uni version="1.0"> <br /><status id="4">рабочий</status> <br /> <br /><result_text>Программа добавлена ранее</result_text> <br /></uni> <br />где: <br /> <p>- ID программы;</p> <br /> <br /><status id="X"> - статус рекламной площадке в программе. Возможные статусы <p>0 => 'в рассмотрении',</p> <p>2 => 'отключена рекламодателем', </p> <p>3 => 'отключена мной',</p> <p>4 => 'рабочий', </p> <p>5 => 'рекламодатель отклонил заявку',</p> <p>7 => 'рекламодатель отключен системой', </p> <p>8 => 'заявка отклонена мной',</p> <p>9 => 'рассматривается мной', </p> <p>10 => 'повторная заявка рекламодателю',</p> <p>11 => 'запрещено работать в ПДП', </p> <p>12 => 'программа взаимоисключена'</p> <br /> <br /><result_text> - уточнение статуса <br /> <b><span>Получение</span></b><b><b> рекламной ссылки и рекламных материалов</b></b> <p>Для получения ссылки и рекламных материалов необходимо сформировать запрос в виде http://mixmarket.biz/uni/api.php?id=xxx&pass=xxx&program_id=zzz&e=materialslist.</p> <p>В ответе будет XML-файл в формате: <br /> <br /><?xml version='1.0' encoding='windows-1251'?> <br /> <br /><uni version="1.0"> <br /> <br /><advmaterials program_id="7"> <br /> <br /><link></link> <br /> <br /><advmaterial id="22" type="1"> <br /> <br /><text>Миксмаркет - полномасштабная партнерская сеть рунета</text> <br /> <br /></advmaterial> <br /> <br /><advmaterial id="26" type="2"> <br /> <br /><heigt>300</heigt> <br /> <br /><width>300</width> <br /> <br /><file></file> <br /> <br /></advmaterial> <br /> <br /><advmaterial id="56" type="3"> <br /> <br /><heigt>60</heigt> <br /> <br /><width>468</width> <br /> <br /><flashvar>ClickTag</flashvar> <br /> <br /><file></file> <br /> <br /></advmaterial> <br /> <br /><advmaterial id="88" type="6"> <br /> <br /><title>Разместите товары на mixmarket.biz!

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



100

88










где:

- рекламная ссылка для всех рекламных материалов, в которой нужно указать номер среза для идентификации трафика и указать адрес страницы рекламодателя. Если redir=1, то рекламодатель задает жесткую ссылку на свою страницу и ее не нужно указывать

- описание рекламного материала.

Есть 4 типа рекламных материалов доступных через API

Текстовая ссылка (type=1), где указан только тест ссылки.



Миксмаркет - полномасштабная партнерская сеть рунета


Графический баннера (type=2) с параметрами: ширина, высота и адрес баннер.



300

300




Flash-баннер (type=3)с параметрами: ширина, высота, переменная баннера для указания ссылки и адрес баннера



60

468

ClickTag



Внимание! Все баннеры используют переменную для рекламной ссылки (тег flashvar), поэтому баннер нужно устанавливать в виде "56.swf?ClickTag=http://site.ru"


Объявление (type=6) с параметрами: название, текст объявления, размер и адрес картинки.



Разместите товары на mixmarket.biz!

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



100

88






Работа с отчетами по кликам и событиям

Для получения отчета по кликам необходимо указать: http://mixmarket.biz/uni/api.php?id=xxx&pass=xxx&e=clicksreport&period={day|week|month}&zip={0|1}

В ответе будет XML-файл в формате:









2011-01-01 12:00

{Название рекламодателя}

Свободный формат

1.1.1.1

CDATA[{Адрес страницы рефера при входе не рекламную площадку. Если он есть!}]]>

CDATA[{Адрес страницы источника клика/перехода }]]>

CDATA[Адрес страницы клика/перехода на сайте рекламодателя]]>






Для получения отчета по событиями необходимо указать: http://mixmarket.biz/uni/api.php?id=xxx&pass=xxx&e=eventsreport&period={day|week|month}&zip={0|1}

В ответе будет XML-файл в формате:










{waiting|cancelled|validated}

2011-01-01 12:00

Размер партнерского вознаграждения

Размер потенциальной суммы вознаграждения
Реальная сумма заказа, сделанного пользователем

{Название условия}

{Название программы}

{Название рекламодателя}

1.1.1.1

{Название рекламной площадки}

Свободный формат

2011-01-01 12:00

{ID клика}

{Переданное значение stat_id}


{Переданное значение sub_id}

{id события переданное рекламодателем }






При использовании period=custom в заголовке будет указан период отчета

или

Параметр при одном и том же (id события на стороне рекламодателя ) может иметь до 3х типовых значения waiting|cancelled|validated.


Статус waiting - первоначальное или промежуточное событие, у которого будут наследники (статусы validated или cancelled), в этом случае могут быть переданы параметры — реальная сумма заказа, на основе которой рассчитывается (потенциальная сумма вознаграждения партнера). Параметр
может быть нулевым (это значит, что за открытое событие по условиям программы партнерское начисление идет с нулевой ценой), так и с начислением, например, если рекламодатель проводит начисление за промежуточное событие, такое как оформление заказа.
Пример:

waiting
2014-09-18 11:37

0.00


51.9232
532
Заказ оформлен

Оплата заказа в My-shop.ru



Мой магазин, ООО
213.70.98.2
site.ru
Свободный формат
2014-09-15 09:44
121144639
16190
16190
3327731

Статус cancelled - конечное событие без наследников, где , и


будут иметь нулевые значения, по факту это означает, что заказ не подтвержден / отменен.
Пример:


cancelled
2014-09-18 11:30

0.00


0
0
Заказ оформлен

Оплата заказа в My-shop.ru



Мой магазин, ООО
213.70.98.2
site.ru
Свободный формат
2014-09-15 09:44
121144639
16190
16190
3327696

Статус validated – означает конечное событие без наследников с начислением, где всегда будет иметь нулевое значение и


(сумма конечного партнерского вознаграждения) обязательно положительное.

Пример:



validated
2014-09-18 00:11

45.68


0
468
Заказ доставлен и оплачен

Оплата заказа в My-shop.ru



Мой магазин, ООО
78.25.122.218
site.ru
XML
2014-08-25 19:05
118353345
3237464

Обратите внимание, что встречаются программы, где по условиям партнерское вознаграждение начисляется сразу, тогда у события бывает только один статус validated (статусы waiting или cancelled отсутствуют, в том числе может быть не передан , т.к. нет необходимости отслеживать его дальнейшие статусы).

Внимание!

Все отчеты кэшируются, поэтому после запроса period=day в течение 5 минут будет отдавать только кэшированный отчет, а для period=week или period=month отчет кэшируется на 12 часов.




info@mixmarket.biz



Поделитесь с Вашими друзьями:


База данных защищена авторским правом ©uverenniy.ru 2019
обратиться к администрации

    Главная страница