RESTful API
From Wiki.zanox.com
Contents |
[edit] RESTful API
The REST API design is based onto the RESTful paradigm. The RESTful paradigm consists of resources that include several actions that can be performed on them.
[edit] API Location
Two different RESTful interfaces are available: XML and JSON. Both are available via http or https. The API can be used without a version parameter in the URL. If used without the version parameter the latest API version is always taken. In order to stick to a certain version the release date of the API has to be provided as a parameter.
API without version support (always latest)
http://api.zanox.com/json || https://api.zanox.com/json http://api.zanox.com/xml || https://api.zanox.com/xml
API with version support
http://api.zanox.com/json/2008-05-21 || https://api.zanox.com/json/2008-05-21 http://api.zanox.com/xml/2008-05-21 || https://api.zanox.com/xml/2008-05-21
To differentiate the versions, please check the REST Webservices Change Logs
[edit] API Authentication
Two different types of authentication are necessary to use the RESTful API. The implementation details can be found in the
RESTful API authentication process section.
[edit] API RESTful Resources
The RESTful API contains RESOURCES that can be accessed for various actions. Actions refers to the HTTP commands GET/POST/PUT and DELETE. The GET command means retrieving a resource, POST means creating a resource, PUT means updating a resouce and DELETE means removing a resource.
Resources are advertising spaces, product offerings, advertising media, advertiser programs, transaction reports and user profiles. Be aware that not all of these resources can be modified.
Adspaces Resource
Operations on advertising spaces:
- Creating a new advertising space
- Updating properties of an advertising space
- Removing an advertising space
- Retrieving the properties of an advertising space
- Retrieving the properties of all advertising space owned by the requesting user
Retrieval of product offerings
- Retrieving a single product item
- Retrieving all product items for an advertiser program
- Retrieving all product items for an advertiser program limited to an advertising space
- Retrieving all product items for an advertiser program limited to a modified date
- Retrieving products by a given search string (contextual matching)
- Retrieving products by a given search string and limited to an advertising space
Retrieval of advertising media
- Retrieving a single advertising medium
- Retrieving a list of advertising media for an advertiser program
- Retrieving a list of advertising media categories for an advertiser program
- Retrieving a list of advertising media for an advertiser program by a given category
- Retrieving a list of advertising media for an advertiser program by a given admedia type
- Retrieving a list of advertising media for an advertiser program, an IP address, an admedia category and a link format
Operations on advertiser program applications
- Creating a new program application
- Remove an advertiser program application from an advertising space
- Retrieving all advertiser programs
- Retrieving the properties of an advertiser program
- Searching for programs by a given search term
- Retrieving all advertiser programs for a given category
- Retrieving the last 20 advertiser program news
- Retrieving the advertiser program categories
- Retrieving all advertiser programs for a distinct advertising space
Operations on reports
Operations on payments
- Retrieving a single payment
- Retrieving all payments
- Retrieving a single balance
- Retrieving all balances
- Retrieving a single account
- Retrieving all accounts
Operations on profiles