Actionpay API

Последние изменения:

Запросы

Форма URL для запроса

https://api.actionpay.net/ru-ru/<apiMethodName>/?key=<apiKey>&format=<format>&a=1&b=2&c=...

Доступные методы для любых пользователей:

Доступные методы для вебмастеров:

Доступные методы для рекламодателей:

Ответы

Возвращаемый массив данных всегда имеет один корневой элемент с именем result или error. Структура данных не зависит от формата. Используемая кодировка — UTF-8.

error

error означает, что произошла ошибка, и содержит два элемента: code и text — код и описание ошибки. Коды ошибок:

Пример ошибки в формате XML:

<error>
    <code type="integer">400</code>
    <text type="string">Неверно задан запрос: не заполнено key</text>
</error>

Пример ошибки в формате JSON:

{ "error": { "code":400, "text":"Неверно задан запрос: не заполнено key" } }

result

result означает, что запрос выполнен успешно, и содержит возвращаемые данные.

В формате XML каждый элемент с данными содержит аттрибут type с типом значения, где может быть string, integer, float, boolean или NULL

Методы

apiWmOffers

Позволяет просматривать детальную информацию об офферах. Выводит только офферы, которые доступные вебмастеру на его текущем тарифе. Отображает только активные офферы.

Параметры:

Примеры запросов списка:

https://api.actionpay.net/ru-ru/apiWmOffers/?key=KEY&format=xml
https://api.actionpay.net/ru-ru/apiWmOffers/?key=KEY&format=xml&category=19
https://api.actionpay.net/ru-ru/apiWmOffers/?key=KEY&format=xml&page=1
https://api.actionpay.net/ru-ru/apiWmOffers/?key=KEY&format=xml&timestamp=2013-10-07 15:41:51
https://api.actionpay.net/ru-ru/apiWmOffers/?key=KEY&format=xml&category=19&page=3&timestamp=2013-10-07 15:41:51

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <offers>
        <offer>
            <id type="integer">123</id>
            <name type="string">Название оффера</name>
            <description type="string">
                Описание оффера
            </description>
            <link type="string">http://offer.site.ru/</link>
            <storedLogo type="string">http://offer.site.ru/logo.png</storedLogo>
            <createDate type="string">2012-01-01</createDate>
            <customLandings type="boolean">true</customLandings>
            <deeplink type="boolean">false</deeplink>
            <geo>
                <excludeCountries type="boolean">true</excludeCountries>
                <includeCountries>
                    <includeCountry type="string">RU</includeCountry>
                </includeCountries>
                <includeCities/>
                <excludeCities/>
            </geo>
            <categories>
                <category>
                    <id type="integer">9</id>
                    <name type="string">ТВ-магазин</name>
                </category>
                ...
            </categories>
            <deniedTrafficTypes>
                <deniedTrafficType>
                    <id type="integer">159</id>
                    <name type="string">Мотивированный трафик</name>
                </deniedTrafficType>
                ...
            </deniedTrafficTypes>
            <adultsOnly type="boolean">false</adultsOnly>
            <rating>1.5</rating>

            <!-- данные для выборки оффера -->
            <status>
                <id type="integer">2</id>
                <name type="string">Активен</name>
            </status>
            <geoString>Москва, Московская область, Брянск, Череповец, Украина</geoString>
            <minTariff>
                <id type="integer">1</id>
                <name type="string">Базовый</name>
            </minTariff>
            <activateDate type="string">2012-01-01</activateDate>
            <freezeDate type="string">2012-01-01</freezeDate>
            <trafficTypes>
                <trafficType>
                    <name type="string">Контекстная реклама</name>
                    <status type="integer">1</status>
                </trafficType>
                ...
            </trafficTypes>
            <banners>
                <count type="integer">859</count>
                <sizes>
                    <size type="string">120x600 (92)</size>
                    ...
                </sizes>
                <download type="string">http://actionpay.net/ru-ru/wmGetCode/downloadAll/id:12321</download>
            </banners>
            <hasWidgets type="boolean">true</hasWidgets>
            <hasYmls type="boolean">true</hasYmls>
            <Ymls>
                <Yml type="string">http://offer.site.ru/files/catalog.xml</Yml>
                ...
            </Ymls>
            <!-- /данные для выборки оффера -->

            <aims>
                <aim>
                    <id type="integer">16</id>
                    <name type="string">Оформление заказа</name>
                    <price type="string">269.23 RUR</price>
                    <postclick type="integer">30</postclick>
                    <hold type="integer">14</hold>
                    <geo>
                        <excludeCountries type="boolean">true</excludeCountries>
                        <includeCountries>
                            <includeCountry type="string">RU</includeCountry>
                        </includeCountries>
                        <includeCities/>
                        <excludeCities/>
                    </geo>
                    <tariff>
                        <id type="integer">1</id>
                        <name type="string">Базовый</name>
                    </tariff>
                    <acceptRate type="float">99.95</acceptRate>
                </aim>
            </aims>
        </offer>
        <offer>
            ...

Пример запроса одного оффера:

https://api.actionpay.net/ru-ru/apiWmOffers/?key=KEY&format=xml&offer=234

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <offers>
        <offer>
            <id type="integer">234</id>
            ...
        </offer>
</result>

В geo одно из полей excludeCountries или includeCountries принимает значение true вместо списка кодов стран.

Цена в цели рассчитывается с учетом текущего тарифа вебмастера.

В поле trafficType параметр status принимает значения:

Для более подробной информации о YML-файлах офферов рекомендуется использовать метод apiWmYmls.


apiWmMyOffers

Отображает избранные офферы, позволяет подключать к ним и отключать о них источники, настраивать URL возврата трафика и post-URL'ы.

1. Список избранных офферов

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmMyOffers/?key=KEY&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <favouriteOffers>
        <favouriteOffer>
            <offer>
                <id type="integer">234</id>
                <name type="string">Оффер</name>
                <status>
                    <id type="string">2</id>
                    <name type="string">Активен</name>
                </status>
            </offer>
            <available type="boolean">true</available>
            <status>
                <id type="string">1</id>
                <name type="string">Активен</name>
            </status>
            <linksBlocked type="boolean">false</linksBlocked>
            <createDate type="string">2012-07-26</createDate>
            <trafficBackUrl type="string">http://trafback.url</trafficBackUrl>
            <postUrlNewAction type="NULL"/>
            <postUrlGoodAction type="string">http://stat.url/good</postUrlGoodAction>
            <postUrlBadAction type="NULL"/>
            <postUrlPaidAction type="NULL"/>
            <sources>
                <source>
                    <id type="integer">12321</id>
                    <name type="string">actionpay.net</name>
                </source>
            </sources>
        </favouriteOffer>
        <favouriteOffer>
            ...
2. Просмотр избранного оффера

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmMyOffers/?key=KEY&format=xml&offer=234

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <favouriteOffer>
        ...
    </favouriteOffer>
</result>
3. Добавление избранного оффера

Параметры:

Пример запроса:

../apiWmMyOffers/?key=KEY&format=xml&act=add&offer=234

В ответе возвращаются параметры добавленного избранного оффера.

4. Удаление избранного оффера

Параметры:

Пример запроса:

../apiWmMyOffers/?key=KEY&format=xml&act=delete&offer=234

В ответе возвращается true в случае успешного удаления.

5. Настройка избранного оффера

Параметры:

Параметры с URL-ами также могут быть переданы POST-запросом.

Пример запроса:

../apiWmMyOffers/?key=KEY&format=xml&act=options&offer=234&trafficBackUrl=http://tr.af

В ответе возвращаются параметры избранного оффера с изменениями.

6. Лимиты офферов

Возвращает лимиты офферов. Обратите внимание, что в некоторых типах накладываемых ограничений не могут быть отображены конкретные значения value и valueLimit, в этих полях будет NULL. Однако, процент исчерпания лимита всегда будет присутствовать в поле percent.

Пример запроса:

../apiWmMyOffers/?key=KEY&format=xml&act=limits

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <limits>
        <limit>
            <id type="integer">1</id>
            <offer>
                <id type="string">123</id>
                <name type="string">Offer name</name>
            </offer>
            <periodType>
                <id type="string">1</id>
                <name type="string">В сутки</name>
            </periodType>
            <valueType>
                <id type="string">5</id>
                <name type="string">Количество принятых действий</name>
            </valueType>
            <value type="float">825</value>
            <valueLimit type="float">1000</valueLimit>
            <percent type="float">82.50</percent>
        </limit>
   </limits>
</result>


apiWmLandings

Отображает лендинги оффера. Если у оффера включена возможность вебмастерам добавлять собственные лендинги (customLandings), выводит лендинги вебмастера, а также позволяет добавлять, удалять и редактировать их.

1. Список лендингов

Параметры: - offer (обязательный) - ID оффера

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmLandings/?key=KEY&format=xml&offer=234

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
<landings>
    <landing>
        <id type="integer">45911</id>
        <name type="string">Tvigle kids</name>
        <url type="string">http://www.tvigle.ru/kids/</url>
        <isCustom type="boolean">false</isCustom>
    </landing>
    <landing>
            ...

isCustom указывает на то, что лендинг был добавлен вебмастером, и может быть им изменен или удален.

2. Добавление и удаление лендинга

Параметры: - act=save обязательный указатель действия - offer (обязательный) - ID оффера - landing (опциональный) - если указан ID, то этот лендинг будет изменен, иначе будет создан новый - name (обязательный) - название лендинга - url (обязательный) - URL лендинга

landing, name и url также могут быть переданы POST-запросом.

Пример запроса:

.../apiWmLandings/?key=KEY&format=xml&offer=234&act=save&name=Шапки&url=http://shop.com/hats

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <landing>
        <id type="integer">45678</id>
        <name type="string">Шапки</name>
        <url type="string">http://shop.com/hats</url>
        <isCustom type="boolean">true</isCustom>
    </landing>
</result>
3. Удаление лендинга

Параметры: - act=delete обязательный указатель действия - landing (обязательный) - ID лендинга

Пример запроса:

.../apiWmLandings/?key=KEY&format=xml&act=delete&landing=45678

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result type="boolean">true</result>


apiWmSources

Возвращает информацию о источниках вебмастера.

1. Список источников

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmSources/?key=KEY&format=xml&active=1

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <sources>
        <source>
            <id type="integer">12321</id>
            <name type="string">my.source.ru</name>
            <description type="string">Мой блог</description>
            <type>
                <id type="string">1000</id>
                <name type="string">Другое</name>
            </type>
            <status>
                <id type="string">2</id>
                <name type="string">Активен</name>
            </status>
            <createDate type="string">2012-07-26 18:00:26</createDate>
            <modifyDate type="string">2012-08-31 11:42:27</modifyDate>
        </source>
        <source>
            ...
2. Информация о источнике по его ID

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmSources/?key=KEY&format=xml&source=12321

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <source>
        <id type="integer">12321</id>
        ...
    </source>
</result>


apiWmSubaccounts

Возвращает список субаккаунтов, которые когда-либо были использованы вебмастером.

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmSubaccounts/?key=KEY&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <subaccounts>
        <subaccount type="string">subaccount</subaccount>
        <subaccount type="string">direct</subaccount>
        <subaccount type="string">adwords</subaccount>
        <subaccount type="string">rotator</subaccount>
    </subaccounts>
</result>


apiWmYmls

Возвращает информацию о YML-файлах офферов. Позволяет получить персональный YML-файл с диплинками.

1. Список офферов с YML-файлам

Отображаются только активные подключенные офферы.

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmYmls/?key=KEY&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <offer>
        <id type="integer">12</id>
        <name type="string">Offer Name</name>
        <deeplinks type="boolean">true</deeplinks>
        <ymls>
            <yml>
                <id type="integer">123</id>
                <name type="string">YML-каталог</name>
                <file>
                    <url type="string">http://cn.actionpay.net/.../yml123.xml</url>
                    <size type="integer">28094061</size>
                </file>
                <infoFile>
                    <url type="string">http://cn.actionpay.net/.../yml37-info.xml</url>
                    <size type="integer">168</size>
                </infoFile>
                <regionalFile>
                    <url type="string">http://cn.actionpay.net/.../yml37-regional.xml</url>
                    <size type="size">28098978</size>
                    <tag type="string">moscow</tag>
                </regionalFile>
            </yml>
            <yml>
                ...
            </yml>
        </ymls>
    </offer>
            ...
2. Получение YML-файла с диплинками

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmYmls/?key=KEY&format=xml&act=deeplinks&source=12321

Пример ответа: Вы получите указанный YML-файл, в котором все ссылки будут направлены через Ваш диплинк.

YML-файл всегда отдается в исходном формате, поэтому указание параметра format здесь влияет только на формат, в котором будет возвращена ошибка, если она произойдет.


apiWmSubaccounts

Возвращает список субаккаунтов, которые когда-либо были использованы вебмастером.

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmSubaccounts/?key=KEY&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <subaccounts>
        <subaccount type="string">subaccount</subaccount>
        <subaccount type="string">direct</subaccount>
        <subaccount type="string">adwords</subaccount>
        <subaccount type="string">rotator</subaccount>
    </subaccounts>
</result>


apiWmLinks

Возвращает список ссылок для привлечения трафика.

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmLinks/?key=KEY&format=xml&offer=234&source=12321

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <links>
        <link>
            <source>
                <id type="integer">12321</id>
                <name type="string">my.source.ru</name>
            </source>
            <landing>
                <id type="integer">34543</id>
                <name type="string">
                    Страница заказа
                </name>
            </landing>
            <url type="string">
                http://n.actionpay.net/click/1234567890abcdef12345678/34543/12321/subaccount
            </url>
            <cleanUrl type="string">http://myoffer.ru/shop/</cleanUrl>
            <isDefaulted type="boolean">false</isDefaulted>
            <transits>
                <transit>
                    <name type="string">Прокладка - блог</name>
                    <url type="string">
                        http://n.actionpay.net/click/1234567890abcdef87654321/78987/12321/subaccount?!aplp=myoffer
                    </url>
                    <cleanUrl type="string">
                        http://shop-blog.ru/?page=myoffer
                    </cleanUrl>
                </transit>
                <transit>
                    ...
                </transit>
            </transits>
        </link>
        <link>
            ...

Внимание! Флаг isDefaulted означает, что лендинг отключен, и трафик по данной партнерской ссылке ведёт на основной лендинг оффера. Вам нужно срочно перенаправить трафик, поскольку переходы перестанут засчитыватся через 2 недели после появления этого флага.

apiWmLinkRotators

Возвращает список настроенных ссылочных ротаторов.

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmLinkRotators/?key=KEY&format=xml&id=234

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <rotators>
        <rotator>
            <name type="string">rotator</name>
            <source>
                <id type="integer">12321</id>
                <name type="string">my.source.ru</name>
            </source>
            <link type="string">
                http://n.actionpay.net/rlink/123/456
            </link>
            <rotatedOffers>
                <rotatedOffer type="string">123</rotatedOffer>
                <rotatedOffer type="string">456</rotatedOffer>
                <rotatedOffer type="string">789</rotatedOffer>
                ...
            </rotatedOffers>
        </rotator>
        <rotator>
            ...

apiWmStats / apiAdvStats

1. Получение аггрегированной статистики

Параметры

Примечание: from и till указываются в формате "YYYY-MM-DD". Не допускается указание нескольких фильтров по sudId в одном запросе. При запросе вида subId1=a&subId2=b будет использован только первый фильтр. В ответе сервера для информативности указываются запрошенные даты и параметры.

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmStats/?key=KEY&format=xml&group=offer&from=2014-01-01

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <query>
        <group type="string">offer</group>
        <from type="string">2014-04-20</from>
        <till type="string">2014-04-22</till>
    </query>
    <stats>
        <stat>
            <key>
                <title type="string">234 - Демо Оффер</title>
                <type type="string">Offer</type>
                <value type="integer">234</value>
            </key>
            <offer type="integer">234</offer>
            <clicks type="integer">4</clicks>
            <accepted type="integer">1</accepted>
            <processing type="integer">2</processing>
            <rejected type="integer">3</rejected>
            <conversion type="float">1.5</conversion>
            <paid>
                <RUR type="float">3.2</RUR>
                <USD type="float">0</USD>
                <EUR type="float">0</EUR>
                <UAH type="float">0</UAH>
            </paid>
            <hold>
                <RUR type="float">6.4</RUR>
                <USD type="float">0</USD>
                <EUR type="float">0</EUR>
                <UAH type="float">0</UAH>
            </hold>
            <epc>
                <RUR type="float">3.2</RUR>
                <USD type="float">0</USD>
                <EUR type="float">0</EUR>
                <UAH type="float">0</UAH>
            </epc>
        </stat>
        ...
    </stats>
</result>

Пример ответа с вложенной группировкой (group=offerAndStamp):

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <query>
        <group type="string">offerAndStamp</group>
        <from type="string">2014-04-20</from>
        <till type="string">2014-04-22</till>
    </query>
    <stats>
        <stat>
            <groupKey>
                <title type="string">234 - Демо Оффер</title>
                <type type="string">Offer</type>
                <value type="integer">234</value>
            </groupKey>
            <offer type="integer">234</offer>
            <stats>
                <stat>
                    <key>
                        <title type="string">20.04.2014</title>
                        <type type="string">Stamp</type>
                        <value type="integer">20140420</value>
                    </key>
                    <stamp type="string">2014-04-20</stamp>
                    <clicks type="integer">8</clicks>
                    <accepted type="integer">1</accepted>
                    <processing type="integer">0</processing>
                    <rejected type="integer">2</rejected>
                    <conversion type="float">0.375</conversion>
                    <paid>
                        ...
                    </paid>
                    <hold>
                        ...
                    </hold>
                    <epc>
                        ...
                    </epc>
                </stat>
                <stat>
                    <key>
                        <title type="string">21.04.2014</title>
                        <type type="string">Stamp</type>
                        <value type="integer">20140421</value>
                    </key>
                    <stamp type="string">2014-04-21</stamp>
                    ...
                </stat>
            </stats>
            <groupKey>
                <title type="string">345 - Демо Оффер №2</title>
                <type type="string">Offer</type>
                <value type="integer">345</value>
            </groupKey>
            <offer type="integer">345</offer>
            <stats>
                <stat>
                    <key>
                        <title type="string">20.04.2014</title>
                        <type type="string">Stamp</type>
                        <value type="integer">20140420</value>
                    </key>
                    <stamp type="string">2014-04-20</stamp>
                    ...
                </stat>
            </stats>
        </stat>
        ...
    </stats>
</result>
2. Получение списка доступных группировок

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmStats/?key=KEY&format=xml&act=groupTypes

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <groupTypes>
        <groupType>
            <type type="string">offerAndStamp</type>
            <description type="string">Оффер и дата</description>
            <keyTypes>
                <keyType type="string">Offer</keyType>
                <keyType type="string">Stamp</keyType>
            </keyTypes>
        </groupType>
        ...
    </groupTypes>
</result>
3. Получение детальной статистики

Параметры

Примечание: from и till указываются в формате "YYYY-MM-DD". Не допускается указание нескольких фильтров по sudId в одном запросе. При запросе вида subId1=a&subId2=b будет использован только первый фильтр. Запрашиваемый период не должен превышать 7 дней. В ответе сервера для информативности указываются запрошенные даты и параметры.

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmStats/?key=KEY&format=xml&offer=234&source=12321

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <query>
        <from type="string">2012-08-25</from>
        <till type="string">2012-08-31</till>
        <offer type="string">234</offer>
    </query>
    <actions>
        <action>
            <uniqueid type="string">837cbf8ab90e7fb130a08651</uniqueid>
            <apid type="string">876545678</apid>
            <date type="string">2012-08-29 18:44:16</date>
            <processingEndDate type="string">2012-08-29 18:44:16</processingEndDate>
            <holdEndDate type="string">2012-08-29 18:44:16</holdEndDate>
            <decisionDate type="NULL"/>
            <status>
                <id type="integer">300</id>
                <name type="string">В холде</name>
            </status>
            <ip type="string">1.2.3.4</ip>
            <country type="string">RU</country>
            <city type="string">MOW</city>
            <offer type="integer">234</offer>
            <aim type="integer">1230</aim>
            <landing type="integer">45654</landing>
            <source type="integer">12321</source>
            <subaccount type="string">subaccount</subaccount>
            <price type="NULL"/>
            <priceCurrency type="string">RUB</priceCurrency>
            <payment type="float">3.2</payment>
            <paymentCurrency type="string">RUB</paymentCurrency>
            <getParams>
                <abc type="string">123</abc>
                <xyz type="string">321</xyz>
            </getParams>
        </action>
        ...
    </actions>
    <page type="integer">1</page>
    <itemsPerPage type="integer">50</itemsPerPage>
    <pageCount type="float">1</pageCount>
</result>
3. Запрос по APID-ам или UniqueID

Параметры:

Если передается параметр offer, то массив id[] используется как список APID-ов (идентификатор действия в рамках оффера). Если параметр offer не передается, то массив id[] используется как список UniqueID (глобально уникальные идентификаторы действий). При запросе большого количества действий рекомендуется передавать id[] в POST-запросе.

Пример запроса:

.../apiWmStats/?key=KEY&format=xml&offer=234&id[]=876545678&id[]=987656789

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <actions>
        <action>
            <uniqueid type="string">837cbf8ab90e7fb130a08651</uniqueid>
            <apid type="string">876545678</apid>
            <date type="string">2012-08-29 18:44:16</date>
            <processingEndDate type="string">2012-08-29 18:44:16</processingEndDate>
            <holdEndDate type="string">2012-08-29 18:44:16</holdEndDate>
            <decisionDate type="NULL"/>
            <status>
                <id type="integer">300</id>
                <name type="string">В холде</name>
            </status>
            <ip type="string">1.2.3.4</ip>
            <country type="string">RU</country>
            <city type="string">MOW</city>
            <offer type="integer">234</offer>
            <aim type="integer">1230</aim>
            <landing type="integer">45654</landing>
            <source type="integer">12321</source>
            <subaccount type="string">subaccount</subaccount>
            <price type="NULL"/>
            <payment type="float">3.2</payment>
            <getParams>
                <abc type="string">123</abc>
                <xyz type="string">321</xyz>
            </getParams>
        </action>
        <action>
            ...
    </actions>
</result>


apiGeoCodes

Возращает название города или страны по географическому коду.

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiGeoCodes/?key=KEY&format=xml&code=MOW

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result type="string">
    Москва
</result>


apiCategories

Возращает список категорий офферов.

Пример запроса:

https://api.actionpay.net/ru-ru/apiCategories/?key=KEY&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
<categories>
    <category>
        <id type="integer">9</id>
        <name type="string">ТВ-магазин</name>
    </category>
    <category>
        <id type="integer">11</id>
        <name type="string">Развлечения</name>
    </category>
    <category>
        ...


apiSignIn

POST запрос. Возвращает API-ключ по логину, паролю и ключу.

POST параметры:

Пример запроса:

POST /ru-ru/apiSignIn/ HTTP/1.1
Host: actionpay.net
Accept: */*
Content-Type: application/x-www-form-urlencoded

login=devWebmaster&password=123123&key=de5e0166f08d79e6cbca89f92ebb07d927828a05&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <key type="string">KEY12345</key>
</result>


apiWmDashboard

Возвращает статистику и балансы кошельков вебмастера за прошлые сутки.

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <stats>
        <click type="integer">0</click>
        <accept type="integer">0</accept>
        <hold type="integer">0</hold>
        <pay_wm_rur type="integer">0</pay_wm_rur>
        <pay_wm_usd type="integer">0</pay_wm_usd>
        <pay_wm_eur type="integer">0</pay_wm_eur>
    </stats>
    <wallets>
        <wallet>
            <code type="string">RUR</code>
            <title type="string">Рубли</title>
            <balance type="float">7072</balance>
            <hold type="float">5233</hold>
            <available type="float">1839</available>
        </wallet>
            ...
    </wallets>
</result>


apiWmNotices

1. Получение всех новостей

Возвращает список новостей для вебмастера, ограниченные тарифом(по 20 новостей на странице).

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmNotices/?key=KEY&format=xml&page=2

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <notices>
        <notice>
            <id type="integer">11</id>
            <subject type="string">Flirchi разрешает трафик из СНГ! с 05.06.12</subject>
            <createDate type="string">2012-06-05</createDate>
            <text type="string">С вашей помощью кто-то может найти свою судьбу?</text>
            <offers>
                <offer>
                    <id type="integer">1694</id>
                    <name type="string">Flirchi.ru</name>
                    <url type="NULL"></url>
                </offer>
                    ...
            </offers>
            <coupons>
                <coupon>
                    <id type="integer">511</id>
                    <name type="string">скоро</name>
                </coupon>
                    ...
            </coupons>
        </notice>
            ...
    </notices>
    <timestamp type="string">2013-10-08 10:04:54</timestamp>
    <page type="integer">4</page>
    <pageCount type="float">43</pageCount>
</result>
2. Получение непрочитанных новостей

Возвращает список непрочитанных новостей для вебмастера, ограниченные тарифом

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmNotices/unread/?key=KEY&timestamp=2013-10-07 15:41:51&format=xml
или
https://api.actionpay.net/ru-ru/apiWmNotices/?key=KEY&act=unread&timestamp=2013-10-07 15:41:51&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <notices>
        <notice>
            <id type="integer">11</id>
            <subject type="string">Flirchi разрешает трафик из СНГ! с 05.06.12</subject>
            <createDate type="string">2012-06-05</createDate>
            <text type="string">С вашей помощью кто-то может найти свою судьбу?</text>
            <offers>
                <offer>
                    <id type="integer">1694</id>
                    <name type="string">Flirchi.ru</name>
                    <url type="NULL"></url>
                </offer>
                    ...
            </offers>
            <coupons>
                <coupon>
                    <id type="integer">511</id>
                    <name type="string">скоро</name>
                </coupon>
                    ...
            </coupons>
        </notice>
            ...
    </notices>
    <timestamp type="string">2013-10-08 10:04:54</timestamp>
</result>
3. Получение количества непрочитанных новостей

Возвращает количество непрочитанных новостей вебмастера

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmNotices/check/?key=KEY&format=xml
или
https://api.actionpay.net/ru-ru/apiWmNotices/?key=KEY&act=check&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <count type="integer">20</count>
</result>


apiWmTickets

1. Получение всех веток тикетов

Возвращает список веток тикетов вебмастера(по 20 веток на странице).

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmTickets/?key=KEY&format=xml&page=2

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <tickets>
        <ticket>
            <id type="integer">17097</id>
            <subject type="string">Корректировка значений в холде</subject>
            <createDate type="string">2012-12-14</createDate>
            <modifyDate type="NULL"></modifyDate>
            <userRead type="boolean">true</userRead>
            <status>
                <id type="string">3</id>
                <name type="string">Ответ прочитан</name>
            </status>
        </ticket>
            ...
    </tickets>
    <timestamp type="string">2013-10-08 10:35:21</timestamp>
    <page type="integer">1</page>
    <pageCount type="float">14</pageCount>
</result>
2. Получение новых веток тикетов

Возвращает список новых веток тикетов вебмастера.

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmTickets/unread/?key=KEY&timestamp=2013-10-07 15:41:51&format=xml
или
https://api.actionpay.net/ru-ru/apiWmTickets/?key=KEY&act=unread&timestamp=2013-10-07 15:41:51&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <tickets>
        <ticket>
            <id type="integer">17097</id>
            <subject type="string">Корректировка значений в холде</subject>
            <createDate type="string">2012-12-14</createDate>
            <modifyDate type="NULL"></modifyDate>
            <userRead type="boolean">true</userRead>
            <status>
                <id type="string">3</id>
                <name type="string">Ответ прочитан</name>
            </status>
        </ticket>
            ...
    </tickets>
    <timestamp type="string">2013-10-08 10:35:21</timestamp>
</result>
3. Получение количества непрочитанных тикетов

Возвращает количество непрочитанных тикетов вебмастера

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmTickets/check/?key=KEY&format=xml
или
https://api.actionpay.net/ru-ru/apiWmTickets/?key=KEY&act=check&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <count type="integer">20</count>
</result>
4. Получение сообщений тикета

Возвращает сам тикет, а также все сообщения тикета

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmTickets/view/?key=KEY&ticket=21336&format=xml
или
https://api.actionpay.net/ru-ru/apiWmTickets/?key=KEY&act=view&ticket=21336&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <ticket>
        <id type="integer">21336</id>
        <subject type="string">ололо</subject>
        <createDate type="string">2013-06-14</createDate>
        <modifyDate type="string">2013-09-10</modifyDate>
        <userRead type="boolean">true</userRead>
        <status>
            <id type="string">1</id>
            <name type="string">Неотвечен</name>
        </status>
        <sender>
            <name>Иван Петров</name>
            <itsMe>true</itsMe>
        </sender>
    </ticket>
    <messages>
        <message>
            <sender>
                <name>Иван Петров</name>
                <itsMe>true</itsMe>
            </sender>
            <createDate type="string">10.09.2013 в 10:18</createDate>
            <text type="string">Сообщение 1</text>
        </message>
            ...
    </messages>
</result>
5. Создание тикета

POST запрос. Создает и возвращает тикет и сообщение

GET параметры:

POST параметры:

Пример запроса:

POST /ru-ru/apiWmTickets/?act=add&format=xml HTTP/1.1 (или POST /ru-ru/apiWmTickets/add/?format=xml HTTP/1.1)
Host: actionpay.net
Accept: */*
Content-Type: application/x-www-form-urlencoded

subject=Trololo&text=mesage

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <ticket>
        <id type="integer">21336</id>
        <subject type="string">ололо</subject>
        <createDate type="string">2013-06-14</createDate>
        <modifyDate type="string">2013-09-10</modifyDate>
        <notification type="integer">112233</userRead>
        <userRead type="boolean">true</userRead>
        <status>
            <id type="string">1</id>
            <name type="string">Неотвечен</name>
        </status>
    </ticket>
    <messages>
        <message>
            <sender type="string">devWebmaster11</sender>
            <createDate type="string">10.09.2013 в 10:18</createDate>
            <text type="string">Сообщение 1</text>
        </message>
    </messages>
</result>
6. Создание сообщения тикета

POST запрос. Создает сообщение в тикете и возвращает тикет и все сообщения

GET параметры:

POST параметры:

Пример запроса:

POST /ru-ru/apiWmTickets/?act=post&format=xml HTTP/1.1 (или POST /ru-ru/apiWmTickets/post/?format=xml HTTP/1.1)
Host: actionpay.net
Accept: */*
Content-Type: application/x-www-form-urlencoded

ticket=21373&text=mesage

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <ticket>
        <id type="integer">21336</id>
        <subject type="string">ололо</subject>
        <createDate type="string">2013-06-14</createDate>
        <modifyDate type="string">2013-09-10</modifyDate>
        <notification type="integer">112233</userRead>
        <userRead type="boolean">true</userRead>
        <status>
            <id type="string">1</id>
            <name type="string">Неотвечен</name>
        </status>
    </ticket>
    <messages>
        <message>
            <sender type="string">devWebmaster11</sender>
            <createDate type="string">10.09.2013 в 10:18</createDate>
            <text type="string">Сообщение 1</text>
        </message>
            ...
    </messages>
</result>


apiWmReferrals

1. Получение списка рефералов

Возвращает ссылку для привлечения партнеров, список привлеченных партнеров и их контактные данные.

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmReferrals/?key=KEY&format=xml

Пример ответа:

<result>
    <link type="string">https://api.actionpay.net/ref:r3f3rr41c0d3</link>
    <referrals>
        <referral>
        <login type="string">foobar</login>
        <registerDate type="string">2014-09-04</registerDate>
        <contacts>
            <skype type="string">foobarskype</skype>
            <icq type="string">123456789</icq>
            <jabber type="NULL"/>
        </contacts>
    </referral>
    <referral>
        ...
</result>
2. Получение информации о ежедневном доходе

Возвращает суммы заработка с рефералов за каждый день за последние 30 дней.

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmReferrals/?key=KEY&act=byDate&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <dates>
        <date>
            <date type="string">2014-08-05</date>
            <actions type="integer">198</actions>
            <payments>
                <payment>
                    <currency type="string">RUR</currency>
                    <amount type="string">443.92</amount>
                </payment>
            </payments>
        </date>
        <date>
            <date type="string">2014-08-06</date>
            <actions type="integer">140</actions>
            <payments>
                <payment>
                    <currency type="string">RUR</currency>
                    <amount type="string">319.97</amount>
                </payment>
            </payments>
        </date>
        <date>
            ...
</result>
3. Получение информации о доходе с каждого из рефералов

Возвращает суммы заработка с рефералов по каждому из них за последние 30 дней.

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmReferrals/?key=KEY&act=byRef&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <total>
        <actions type="integer">3562</actions>
        <payments>
            <payment>
                <currency type="string">RUR</currency>
                <amount type="float">5964.87</amount>
            </payment>
        </payments>
    </total>
    <referrals>
        <referral>
            <login type="string">foobar</login>
            <registerDate type="string">2014-09-04</registerDate>
            <contacts>
                <skype type="string">foobarskype</skype>
                <icq type="string">123456789</icq>
                <jabber type="NULL"/>
            </contacts>
            <actions type="integer">363</actions>
            <payments>
                <payment>
                    <currency type="string">RUR</currency>
                    <amount type="string">272.58</amount>
                </payment>
            </payments>
        </referral>
        <referral>
            ...
</result>


apiWmPayouts

1. Получение информации о балансе и выплатах

Возвращает информацию о балансе кошельков, заказанных выплатах, безналичных переводах и корректироваках баланса.

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmPayouts/?key=KEY&format=xml

Пример ответа:

<result>
    <wallets>
        <wallet>
            <currency type="string">RUR</currency>
            <available type="float">12407.73</available>
            <hold type="float">0</hold>
        </wallet>
        <wallet>
            <currency type="string">USD</currency>
            <available type="float">0</available>
            <hold type="float">0</hold>
        </wallet>
        <wallet>
            <currency type="string">EUR</currency>
            <available type="float">0</available>
            <hold type="float">0</hold>
        </wallet>
    </wallets>
    <emoneys>
        <emoney>
            <id type="integer">23</id>
            <system type="string">WebMoney WMR</system>
            <account type="string">R1234567890</account>
            <currency type="string">RUR</currency>
            <createDate type="string">2014-09-01 12:01:59</createDate>
            <status>
                <id type="string">1</id>
                <name type="string">Активен</name>
            </status>
        </emoney>
    </emoneys>
    <payouts>
        <payout>
            <id type="integer">123</id>
            <currency type="string">RUR</currency>
            <amount type="float">1000</amount>
            <amountPaid type="float">1000</amountPaid>
            <emoney>
                <id type="integer">23</id>
                <system type="string">WebMoney WMR</system>
                <account type="string">R1234567890</account>
                <currency type="string">RUR</currency>
                <createDate type="string">2014-09-01 12:01:59</createDate>
                <status>
                    <id type="string">1</id>
                    <name type="string">Активен</name>
                </status>
            </emoney>
            <requestDate type="string">2014-09-04 13:31:12</requestDate>
            <processDate type="string">2014-09-05 16:27:11</processDate>
            <status>
                <id type="string">3</id>
                <name type="string">Выплачена</name>
            </status>
            <rejectReason type="NULL"/>
        </payout>
    </payouts>
    <wiretransfersOnly type="boolean">false</wiretransfersOnly>
    <wiretransfers>
        <wiretransfer>
            <amount type="float">500</amount>
            <currency type="string">RUR</currency>
            <createDate type="string">2014-09-03 14:45:25</createDate>
            <status>
                <id type="string">200</id>
                <name type="string">Подтверждено</name>
            </status>
            <comment type="string">комментарий менеджера</comment>
        </wiretransfer>
    </wiretransfers>
    <corrections>
        <correction>
            <operation>
                <id type="string">1</id>
                <name type="string">пополнить</name>
            </operation>
            <amount type="float">100</amount>
            <currency type="string">RUR</currency>
            <status>
                <id type="string">2</id>
                <name type="string">Принята</name>
            </status>
            <comment type="string">комментарий менеджера</comment>
        </correction>
    </corrections>
</result>
2. Заказ выплаты

Возвращает суммы заработка с рефералов за каждый день за последние 30 дней.

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmPayouts/?key=KEY&format=xml&emoney=123&amount=1000

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <ok type="boolean">true</ok>
    <payout>
        <id type="integer">124</id>
        <currency type="string">RUR</currency>
        <amount type="float">1000</amount>
        <amountPaid type="NULL"/>
        <emoney>
            <id type="integer">23</id>
            <system type="string">WebMoney WMR</system>
            <account type="string">R1234567890</account>
            <currency type="string">RUR</currency>
            <createDate type="string">2014-09-01 12:01:59</createDate>
            <status>
                <id type="string">1</id>
                <name type="string">Активен</name>
            </status>
        </emoney>
        <requestDate type="string">2014-09-04 13:31:12</requestDate>
        <processDate type="NULL"/>
        <status>
            <id type="string">1</id>
            <name type="string">Ожидает обработки</name>
        </status>
        <rejectReason type="NULL"/>
    </payout>
</result>

Пример ответа в случае ошибки:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <ok type="boolean">false</ok>
    <error type="string">
        Выплаты заблокированы для данного аккаунта
    </error>
    <errorCode type="integer">1</errorCode>
</result>


apiNotifications

1. Получение списка уведомлений

Возвращает список уведомлений. В ответе содержится одна страница уведомлений - 25 записей.

Пример запроса:

https://api.actionpay.net/ru-ru/apiNotifications/?key=KEY&format=xml

Параметры:

Пример ответа:

<result>
    <notifications>
        <notification>
            <id type="integer">112233</id>
            <subject type="string">
                Трафик на отключенном оффере
            </subject>
            <text type="string">
                От вас идет трафик на оффер "X".
                Вы отключились от него, действия по нему не принимаются.
                Просьба подключиться к офферу снова или срочно перевести трафик!
            </text>
            <link type="NULL"/>
            <createDate type="string">2014-08-15</createDate>
            <expireDate type="NULL"/>
            <importance>
                <id type="string">300</id>
                <name type="string">Критичная</name>
            </importance>
            <solving>
                <id type="string">1</id>
                <name type="string">Не требует решения</name>
            </solving>
            <status>
                <id type="string">1</id>
                <name type="string">Новое</name>
            </status>
            <ticket type="integer">32132</ticket>
        </notification>
        <notification>
            ...
    </notifications>
    <page type="integer">1</page>
    <pageCount type="float">5</pageCount>
</result>
2. Количество непрочитанных уведомлений

Возвращает количество непрочитанных уведомлений.

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiNotifications/?key=KEY&format=xml

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result type="integer">2</result>
3. Удаление уведомлений

Удаляет указанное уведомления из списка уведомлений пользователя

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiNotifications/?key=KEY&format=xml&id=112233

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result type="boolean">true</result>


apiWmLostActions

1. Получение списка потеряных сообщений о потеряных действиях

Параметры:

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmLostActions/?key=KEY&format=xml?offer=111&status=1

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <lostActions>
        <lostAction>
            <id type="integer">19</id>
            <offer type="string">240</offer>
            <eventIdentifier type="string">44545</eventIdentifier>
            <description type="string">problem description</description>
            <source type="integer">32177</source>
            <orderDate type="string">2017-07-10</orderDate>
            <orderSum type="string">12.3000</orderSum>
            <currency type="string">1</currency>
            <documents/>
            <status>
                <id type="integer">1</id>
                <name type="string">Новая</name>
            </status>
    </lostActions>
</result>
2. Добавление сообщения

Параметры: - orderDate - (обязательный) дата заказа - offer - (обязательный) ID оффера - description - (обязательный) комментарий - eventIdentifier - (обязательный) номер заказа - source (обязательный) ID источника - orderSum (обязательный) сумма заказа - currency (обязательный) валюта - documents - (опциональный) Фотографии чеков или другие материалы, подтверждающие выполнение действия ('image/png', 'image/jpeg', 'application/zip')

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmLostActions/add/?key=key=KEY&format=xml&offer=240&eventIdentifier=ssdsd&description=fuck&source=32177&orderDate=2017-07-10&orderSum=12.30&currency=1

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <lostAction>
        <id type="integer">19</id>
        <offer type="string">240</offer>
        <eventIdentifier type="string">23232323</eventIdentifier>
        <description type="string">problem description</description>
        <source type="integer">32177</source>
        <orderDate type="string">2017-07-10</orderDate>
        <orderSum type="string">12.3</orderSum>
        <currency type="string">RUR</currency>
        <documents/>
        <status>
            <id type="integer">1</id>
            <name type="string">Новая</name>
        </status>
    </lostAction>
</result>
3. Получение сообщения

Параметры: - id - (обязательный) ID сообщения

Пример запроса:

https://api.actionpay.net/ru-ru/apiWmLostActions/view/?key=KEY&format=xml&id=11

Пример ответа:

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <lostAction>
        <id type="integer">11</id>
        <offer type="string">240</offer>
        <eventIdentifier type="string">12112</eventIdentifier>
        <description type="string">problem</description>
        <source type="integer">32177</source>
        <orderDate type="string">2017-07-14</orderDate>
        <orderSum type="string">122.0000</orderSum>
        <currency type="string">1</currency>
        <documents>
            <document type="string">
                //cn.actionpay.ru/actionpay/14/99/16/test.jpg
            </document>
        </documents>
        <status>
            <id type="integer">1</id>
            <name type="string">Новая</name>
        </status>
    </lostAction>
</result>