Описание методов API
profile
Формат:
GET /api/rest/webmaster/xml/profile
Описание:
Возвращает данные пользователя
Входные параметры:
Ответ:
- <getProfileResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <id>int</id>
- <first_name>string</first_name>
- <last_name>string</last_name>
- <language>string</language>
- <phone>string</phone>
- <contact_phone>string</contact_phone>
- <email>string</email>
</data>
</getProfileResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/profile?remote_auth=6420072d37bf14f1df182d0fe0efa2d9profile
Формат:
PUT /api/rest/webmaster/xml/profile
Описание:
Обновить профиль пользователя
Входной PUT-запрос в формате XML:
- <setProfileRequestData>
- <first_name>string <!--Ваше имя--></first_name>
- <last_name>string <!--Ваша фамилия--></last_name>
- <phone>string <!--Основной номер телефона, используемый для верификации аккаунта. Этот параметр больше не поддерживается и будет удален в новых версиях API. Используйте contact_phone для указания контактного телефона. Верификационный номер телефона Вы можете задать в личном кабинете или связавшись в персональным менеджером.--></phone>
- <contact_phone>string <!--Номер контактного телефона--></contact_phone>
</setProfileRequestData>
Ответ:
- <setProfileResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>boolean</data>
</setProfileResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/profile?remote_auth=6420072d37bf14f1df182d0fe0efa2d9balanceinfo
Формат:
GET /api/rest/webmaster/xml/balanceinfo
Описание:
Возвращает информацию о балансе аккаунта
Входные параметры:
Ответ:
- <getBalanceInfoResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <payment_schedule>string <!--График выплат--></payment_schedule>
- <hold_city>int <!--Количество дней, пока трафик проверяет CityAds--></hold_city>
- <currency>string <!--Валюта вебмастера--></currency>
- <main_balance>float <!--Баланс с учетом заработка на проверке Рекламодателя и CityAds--></main_balance>
- <commission_hold_adv>float <!--Заработок на проверке Рекламодателя--></commission_hold_adv>
- <commission_hold_city>float <!--Заработок на проверке CityAds--></commission_hold_city>
- <earnings_on_payment>float <!--Сумма заработка в невыплаченных заявках--></earnings_on_payment>
- <available_balance>float <!--Сумма доступная для выплаты--></available_balance>
</data>
</getBalanceInfoResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/balanceinfo?remote_auth=6420072d37bf14f1df182d0fe0efa2d9notificationsettinglist
Формат:
GET /api/rest/webmaster/xml/notificationsettinglist
Описание:
Возвращает список всех подписок и статус по каждой для вебмастера
Входные параметры:
Ответ:
- <getNotificationSettingListResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <items>
- <item>
- <news_category_id>int</news_category_id>
- <news_category_name>string</news_category_name>
- <status>int</status>
</item>
</items>
</data>
</getNotificationSettingListResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/notificationsettinglist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9notificationsettinglist
Формат:
PUT /api/rest/webmaster/xml/notificationsettinglist
Описание:
Устанавливает статус подписок по пользователю
Входной PUT-запрос в формате XML:
- <setNotificationSettingListRequestData>
- <item>
- <news_category_id>int</news_category_id>
- <status>int</status>
</item>
</setNotificationSettingListRequestData>
Ответ:
- <setNotificationSettingListResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>boolean</data>
</setNotificationSettingListResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/notificationsettinglist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9payoutlist
Внимание! Метод payoutlist находится в процессе разработки
Формат:
GET /api/rest/webmaster/xml/payoutlist?start=<int>&limit=<int>
Описание:
История выплат
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
int | start | | | |
int | limit | | | |
Ответ:
- <getPayoutListResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <items>
- <item>
- <id>long</id>
- <value>float</value>
- <added_at>string</added_at>
- <processed>int</processed>
- <processed_at>string</processed_at>
- <referal_id>string</referal_id>
- <xkeyTrans>int</xkeyTrans>
- <account_to_id>int</account_to_id>
- <account_from_id>int</account_from_id>
- <name>string</name>
- <submission_id>int</submission_id>
- <date>date</date>
- <status_name>string</status_name>
</item>
</items>
</data>
</getPayoutListResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/payoutlist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9chargehistorylist
Внимание! Метод chargehistorylist находится в процессе разработки
Формат:
GET /api/rest/webmaster/xml/chargehistorylist?start=<int>&limit=<int>
Описание:
История начислений
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
int | start | | | |
int | limit | | | |
Ответ:
- <getChargeHistoryListResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <items>
- <item>
- <date>date</date>
- <amount>float</amount>
- <description>string</description>
</item>
</items>
</data>
</getChargeHistoryListResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/chargehistorylist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9exchangeratelist
Формат:
GET /api/rest/webmaster/xml/exchangeratelist?start=<int>&limit=<int>
Описание:
Курсы валют
Входные параметры:
Тип: | Имя: | Описание: | Допустимые значения: | Обязательное: |
---|
int | start | | | |
int | limit | | | |
Ответ:
- <getExchangeRateListResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <total>int</total>
- <items>
- <item>
- <date>date</date>
- <usd2rur>string</usd2rur>
- <rur2usd>string</rur2usd>
- <eur2rur>string</eur2rur>
- <rur2eur>string</rur2eur>
- <eur2usd>string</eur2usd>
- <usd2eur>string</usd2eur>
</item>
</items>
</data>
</getExchangeRateListResponseData>
Пример:
http://cityads.com/api/rest/webmaster/xml/exchangeratelist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9