Москва
Каталог
Каталог Товаров
Стройматериалы
Стройматериалы
Одежда и обувь
Одежда и обувь
Продукты и напитки
Продукты и напитки
Текстиль и кожа
Текстиль и кожа
Здоровье и красота
Здоровье и красота
Детские товары
Детские товары
Мебель и интерьер
Мебель и интерьер
Дом и сад
Дом и сад
Электротехника
Электротехника
Сельское хозяйство
Сельское хозяйство
Вода, газ и тепло
Вода, газ и тепло

Сервис API

Все запросы к API отправляются по адресу: regmarkets.ru/api/

Формат запроса

GET regmarkets.ru/api/{method}/?token=[mode=]

Фильтры параметров запроса:

Path-параметры

    method - один из методов получения данных. Возможные значения getStatClick getAccount getBalance

Query - параметры доступные во всех методах.

    token - Обязательный. Для того чтобы работать с системой API требуется токен. Обратитесь к своему менеджеру чтобы его получить.

    mode - формат вывода данных. По умолчанию json, если указать xml, то данные будут отданы в формате xml.

Методы:
Метод getStatClick- статистика кликов
Метод getAccount- список дополнительных аккаунтов
- Метод getBalance - текущий баланс главного аккаунта и последние 10 транзакций списания;
- Метод getStatOrder- текущий баланс главного аккаунта и последние 10 транзакций списания.
- Метод getTransaction - текущий баланс главного аккаунта и последние 10 транзакций списания.

Метод getStatClick - статистика кликов

Формат запроса

regmarkets.ru/api/getStatClick/?token=<string>[Query-параметры]

Фильтры параметров запроса:

dateFrom - указывается дата начала выборки;

dateTo - указывается конец периода выборки;

Дату можно указывать как полностью 12.11.2020 15:00:00 так и сокращенно, только дата без времени 12.11.2020.

dateTo - обращаем внимание, что дата конца выборки не включается в запрос, т.е. если в запросе указывается dateFrom=01.11.2020&dateTo=05.11.2020, то тогда будет результат  с 1 по 4 число;

Если указывается dateFrom=01.11.2020 00:00:00&dateTo=05.11.2020 20:00:00 то в запросе будут клики все с 01.11.2020 00:00:00 и до 05.11.2020 19:59:59 включительно.

accountID - в этом параметре указывается либо один ID аккаунта (ID аккаунта Вы може найти в личном кабинете, раздел “настройки профиля” и далее вкладка “данные для входа”) либо список ID ваших акканутов  через запятую. Список доступных аккаунтов можно получить через метод getAccount;

promo - используется для запроса кликов по вашим промо товарам (в случае если у вас активно промо размещение), для этого требуется указать “true”. По умолчанию используется “false”.

limit - количество элементов в запросе. Максимум 1000. По умолчанию используется максимальное допустимое значение 1000;

page - номер страницы.


Формат ответа

XML

<result date="YYYY-MM-DDThh:mm:ss">

<accounts>

<account>
<account_id>int32</account_id>

<companyName>string</companyName>

<companyEmail>string</companyEmail>

<multi>boolean</multi>

<partner>boolean</partner>

</account>

...

</accounts>
<page>
<total>int32</total>

<countPage>int32</countPage>

<countResult>int32</countResult>

<page>int32</page>

<limit>int32</limit>

<dateMin>YYYY-MM-DDThh:mm:ss</dateMin>

<dateMax>YYYY-MM-DDThh:mm:ss</dateMax>

</page>

<items>

<item>
<accountID>int32</accountID>

<dateTime>YYYY-MM-DDThh:mm:ss</dateTime>

<priceProduct>float</priceProduct>

<priceClick>float</priceClick>

<productName>string</productName>

<offer_id>string</offer_id>

<cityName>string</cityName>

<timeAction>int32</timeAction>

<promo>boolean</promo>

</item>

...

</items>
</result>

JSON

accounts: [

    {

    account_id: int32

    companyEmail: "string"

    companyName: "string"

    multi: "boolean"

    partner: "boolean"

    }
  ]
page: {

    countPage: int32

    countResult: int32

    dateMax: "YYYY-MM-DDThh:mm:ss"

    dateMin: "YYYY-MM-DDThh:mm:ss"

    limit: int32

    page: int32

    total: int32

    }

stat_click: [

    {

    accountID: int32

    cityName: "string"

    dateTime: "YYYY-MM-DDThh:mm:ss"

    offer_id: "string"

    priceClick: "float"

    priceProduct: "float"

    productName: "string"

    promo: "boolean"

    timeAction: int32

    }


Описание:

accounts - список аккаунтов участвующие в выборке;

account - элемент списка аккаунтов;

account_id - идентификатор аккаунта;

companyName - название аккаунта;

companyEmail - E-mail аккаунта;

multi - если true, то является мультиаккаунтом;

partner - если true, то является партнером;

page - данные по выбранной странице;

total - всего кликов по указанным Query параметрам;

countPage - количество доступных страниц;

countResult - количество выбранных кликов на текущей странице;

page - номер текущей страницы;

limit - указанный лимит количества кликов на одну страницу;

dateMin - минимальная дата клика в выборке;

dateMax - максимальная дата клика в выборке;

items - список выбранных кликов;

item - элемент списка, один клик;

accountID - идентификатор аккаунта товара;

dateTime - время клика;

priceProduct - цена товара;

priceClick - стоимость клика;

productName - название товара;

offer_id - offer_id из файла xml;

cityName - город совершения клика;

timeAction - время через которое был совершен клик от момента первого посещения сайта, в секундах;

promo - если указывается “true” то клик был по промо товару.

В начало



Метод getAccount - список дополнительных аккаунтов

Формат запроса

regmarkets.ru/api/getAccount/?token=[Query-параметры]

Формат ответа

XML

<result date="YYYY-MM-DDThh:mm:ss">

<accounts>

<account>

<account_id>int32</account_id>

<companyName>string</companyName>

<companyEmail>string</companyEmail>

<multi>boolean</multi>

<partner>boolean</partner>

</account>

...

</accounts>

</result>

JSON

accounts: [

    {

    account_id: int32

    companyEmail: "string"

    companyName: "string"

    multi: "boolean"

    partner: "boolean"

}

]


Описание:

accounts - список доступных аккаунтов;

account - элемент списка аккаунтов;

account_id - идентификатор аккаунта;

companyName - название аккаунта;

companyEmail - E-mail аккаунта;

multi - если true, то является мультиаккаунтом;

partner - если true, то является партнером.

В начало



Метод getBalance - текущий баланс главного аккаунта и последние 10 транзакций списания;

Формат запроса

regmarkets.ru/api/getBalance/?token=[Query-параметры]

Формат ответа

XML

<result date="YYYY-MM-DDThh:mm:ss">

<account>

<account_id>int32</account_id>

<company_name>string</company_name>

<company_email>string</company_email>

</account>

<balance>

<budget>float</budget>

<currency>string</currency>

</balance>

<transaction>

<transact>

<date>YYYY-MM-DDThh:mm:ss</date>

<amount>float</amount>

<currency>string</currency>

</transact>

...

</transaction>

</result>

JSON

account: {

    account_id: int32

    company_email: "string"

    company_name: "string"

    }

balance: {

    budget: "float"

    currency: "string"

    }

transaction: [

    {

    amount: "float"

    currency: "string"

    date: "YYYY-MM-DDThh:mm:ss"

    }

]

Описание:

account - главный аккаунт;

account_id - идентификатор аккаунта;

companyName - название аккаунта;

companyEmail - E-mail аккаунта;

balance - данные по балансу;

budget - текущий баланс главного аккаунта;

currency - валюта;

transaction - список 10 последних транзакций;

amount - сумма транзакции;

currency - валюта;

date - дата транзакции.

В начало



Метод getStatOrder - текущий баланс главного аккаунта и последние 10 транзакций списания.

Формат запроса

regmarkets.ru/api/getStatOrder/?token=[Query-параметры]

Фильтры параметров запроса:

dateFrom - указываем дату начала выборки;

dateTo - указываем конец периода выборки;

Дату можно указывать как полностью 12.11.2020 15:00:00 так и сокращенно только дата без времени 12.11.2020;

dateTo - обращаем внимание, что дата конца выборки не включается в запрос, т.е. если в запросе указывается dateFrom=01.11.2020&dateTo=05.11.2020, то тогда будет результат  с 1 по 4 число;

Если Вы указываете dateFrom=01.11.2020 00:00:00&dateTo=05.11.2020 20:00:00

то в запросе будут клики все с 01.11.2020 00:00:00 и до 05.11.2020 19:59:59 включительно.

accountID - в этом параметре указывается либо один ID аккаунта (ID аккаунта Вы може найти в личном кабинете, раздел “настройки профиля” и далее вкладка “данные для входа”) либо список ID ваших акканутов  через запятую. Список доступных аккаунтов можно получить через метод getAccount;

limit - количество элементов в запросе. Максимум 1000. По умолчанию используется максимальное допустимое значение 1000;

page - номер страницы.


Формат ответа

XML

<result date="YYYY-MM-DDThh:mm:ss">

<accounts>

<account>

<account_id>int32</account_id>

<companyName>string</companyName>

<companyEmail>string</companyEmail>

<multi>boolean</multi>

<partner>boolean</partner>

</account>

</accounts>

<page>

<total>int32</total>

<countPage>int32</countPage>

<countResult>int32</countResult>

<page>int32</page>

<limit>int32</limit>

</page>

<orders>

<order>

<accountID>int32</accountID>

<dateTime>YYYY-MM-DDThh:mm:ss</dateTime>

<price>float</price>

<productName>string</productName>

<offer_id>string</offer_id>

<cityName>string</cityName>

<time>int32</time>

<cart>boolean</cart>

<order>boolean</order>

</order>

</orders>

</result>


JSON

accounts: [

    {

    account_id: int32

    companyEmail: "string"

    companyName: "string"

    multi: "boolean"

    partner: "boolean"

    }

 ]

orders: [

    {

    accountID: int32

    cart: "boolean"

    cityName: "string"

    dateTime: "YYYY-MM-DDThh:mm:ss"

    offer_id: "string"

    order: "boolean"

    price: "float"

    productName: "string"

    time: int32

    }

]

page: {

    countPage: int32

    countResult: int32

    limit: int32

    page: int32

    total: int32

    }


Описание:

accounts - список аккаунтов участвующие в выборке;

account - элемент списка аккаунтов;

account_id - идентификатор аккаунта;

companyName - название аккаунта;

companyEmail - E-mail аккаунта;

multi - если true, то является мультиаккаунтом;

partner - если true, то является партнером;

orders - список сделанных заказов на сайте;

  order - элемент списка один заказ;

    accountID - идентификатор аккаунта товара;

cart - если true то сработало событие посещения корзины;

 cityName - город совершения клика;

 dateTime - время клика;

 offer_id - offer_id из файла xml;

order - если true то сработало событие оформления заказа на сайте;

 price - цена товара;

 productName - название товара;

 time - время конверсии отсчитываемое от момента перехода на сайт компании и событием;

 promo - если указано true то клик был по промо товару;

page - данные по выбранной странице;

total - всего кликов по указанным Query параметрам;

countPage - количество доступных страниц;

countResult - количество выбранных кликов на текущей странице;

page - номер текущей страницы;

limit - указанный лимит количества кликов на одну страницу;

dateMin - минимальная дата клика в выборке;

dateMax - максимальная дата клика в выборке.

В начало

Метод getTransaction - текущий баланс главного аккаунта и последние 10 транзакций списания.

Формат запроса
regmarkets.ru/api/getTransaction/?token=<string>[Query-параметры]

Фильтры параметров запроса:
dateFrom - указываем дату начала выборки;
dateTo - указываем конец периода выборки;
limit - количество элементов в запросе. Максимум 100. По умолчанию используется максимальное допустимое значение 20;
page - номер страницы. По умолчанию 1;

Формат ответа
XML
<result date="YYYY-MM-DDThh:mm:ss">

<account>

<account_id>int32</account_id>

<company_name>string</company_name>

<company_email>string</company_email>

</account>

<transaction>

<transact>

<date>YYYY-MM-DDThh:mm:ss</date>

<amount>float</amount>

<currency>string</currency>

</transact>

...

</transaction>

</result>
JSON
account: {
account_id: int32

company_email: "string"

company_name: "string"

}

transaction: [
{

amount: "float"

currency: "string"

date: "YYYY-MM-DDThh:mm:ss"

}

]
Описание:

account - главный аккаунт;

account_id - идентификатор аккаунта;

companyName - название аккаунта;

companyEmail - E-mail аккаунта;

transaction - список транзакций;

amount - сумма транзакции;

currency - валюта;

date - дата транзакции.

В начало