API Methods
profile
Format:
GET /api/rest/webmaster/xml/profile
Descritption:
Returns user profile info
Input parameters:
Response:
- <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>
Example:
http://cityads.com/api/rest/webmaster/xml/profile?remote_auth=6420072d37bf14f1df182d0fe0efa2d9profile
Format:
PUT /api/rest/webmaster/xml/profile
Descritption:
Update data of user profile
XML PUT-request:
- <setProfileRequestData>
- <first_name>string <!--Your name--></first_name>
- <last_name>string <!--Your surname--></last_name>
- <phone>string <!--The main phone used for profile verification. This parameter is no longer supported and will be removed soon. Please, use the contact_phone parameter to set your contact phone number. If you need change the main phone, please, contact your personal manager or use My Account section at cityads.com --></phone>
- <contact_phone>string <!--Your contact phone number--></contact_phone>
</setProfileRequestData>
Response:
- <setProfileResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>boolean</data>
</setProfileResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/profile?remote_auth=6420072d37bf14f1df182d0fe0efa2d9balanceinfo
Format:
GET /api/rest/webmaster/xml/balanceinfo
Descritption:
Return account balance info
Input parameters:
Response:
- <getBalanceInfoResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>
- <payment_schedule>string <!--Payment schedule--></payment_schedule>
- <hold_city>int <!--Time of traffic approval by CityAds in days--></hold_city>
- <currency>string <!--Currency of the publisher--></currency>
- <main_balance>float <!--Balance including the commission held for approval by Advertisers and CityAds--></main_balance>
- <commission_hold_adv>float <!--Commission held for approval by Advertisers--></commission_hold_adv>
- <commission_hold_city>float <!--Commission held for approval by CityAds--></commission_hold_city>
- <earnings_on_payment>float <!--Total amount of payment applications not yet paid--></earnings_on_payment>
- <available_balance>float <!--Total amount available for payment--></available_balance>
</data>
</getBalanceInfoResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/balanceinfo?remote_auth=6420072d37bf14f1df182d0fe0efa2d9notificationsettinglist
Format:
GET /api/rest/webmaster/xml/notificationsettinglist
Descritption:
Returns the list of subscribes and notification statuses for them
Input parameters:
Response:
- <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>
Example:
http://cityads.com/api/rest/webmaster/xml/notificationsettinglist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9notificationsettinglist
Format:
PUT /api/rest/webmaster/xml/notificationsettinglist
Descritption:
Set statuses of notification lists
XML PUT-request:
- <setNotificationSettingListRequestData>
- <item>
- <news_category_id>int</news_category_id>
- <status>int</status>
</item>
</setNotificationSettingListRequestData>
Response:
- <setNotificationSettingListResponseData>
- <status>int</status>
- <error>string</error>
- <request_id>int</request_id>
- <data>boolean</data>
</setNotificationSettingListResponseData>
Example:
http://cityads.com/api/rest/webmaster/xml/notificationsettinglist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9payoutlist
Attention! Method payoutlist is under construction
Format:
GET /api/rest/webmaster/xml/payoutlist?start=<int>&limit=<int>
Descritption:
Payout List
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | start | | | |
int | limit | | | |
Response:
- <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>
Example:
http://cityads.com/api/rest/webmaster/xml/payoutlist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9chargehistorylist
Attention! Method chargehistorylist is under construction
Format:
GET /api/rest/webmaster/xml/chargehistorylist?start=<int>&limit=<int>
Descritption:
Charge History List
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | start | | | |
int | limit | | | |
Response:
- <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>
Example:
http://cityads.com/api/rest/webmaster/xml/chargehistorylist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9exchangeratelist
Format:
GET /api/rest/webmaster/xml/exchangeratelist?start=<int>&limit=<int>
Descritption:
Exchange Rate List
Input parameters:
Type: | Name: | Description: | Possible values: | Required: |
---|
int | start | | | |
int | limit | | | |
Response:
- <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>
Example:
http://cityads.com/api/rest/webmaster/xml/exchangeratelist?remote_auth=6420072d37bf14f1df182d0fe0efa2d9