keysapi
Differences
This shows you the differences between two versions of the page.
|
keysapi [2011/08/05 19:21] jposeika created |
keysapi [2012/04/22 04:54] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Keys (RESTful) API ====== | ||
| - | Using Keys API you can generate and manipulate ChiliFresh Reviews API keys. It has output available in XML and JSON. | ||
| - | |||
| - | ===== Covers availability data ===== | ||
| - | ==== Input ==== | ||
| - | * URL for XML output: http://content.chilifresh.com/api/ | ||
| - | * URL for JSON output: http://content.chilifresh.com/api/json/ | ||
| - | * Method: GET | ||
| - | * Available both over plain HTTP and SSL | ||
| - | ==== Parameters ==== | ||
| - | |**Parameter**|**Type (size)**|**Mandatory**|**Description**| | ||
| - | |isbn|Variable characters (20)|Yes|Item's ISBN, UPC or other ID| | ||
| - | |size|Variable characters (50)|No|Options: //S// - small, //M// - medium, //L// - large, //empty// - returns all values. If incorrect size parameter, it is treated as empty.| | ||
| - | |||
| - | |||
| - | ==== Output ==== | ||
| - | * Format: XML, JSON | ||
| - | * Blocks and elements: | ||
| - | |||
| - | |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | ||
| - | |**Block //response// starts**|||Always| | | ||
| - | |response|response_code|Integer (1)|Always|Response code 1 - response OK, 0 - missing item ID| | ||
| - | |response|response_description|Text (255)|Always|Brief description of response code| | ||
| - | |response|response_time|Date&time (D, d M Y H:i:s -hhmm)|Always|Example: Thu, 30 Jun 2010 07:25:58 -0500| | ||
| - | |response|item_id|ISBN, UPC or other item ID |If //isbn// parameter present |ISBN, UPC or other item ID | | ||
| - | |response|small_cover_exists|1 or 0 |If //size// parameter is "S" or empty|1 if small cover exists, 0 if not| | ||
| - | |response|small_cover_url|URL |If //small_cover_exists// is 1, this parameter includes displays cover URL|If //small_cover_exists// is 1, this parameter includes displays cover URL| | ||
| - | |response|medium_cover_exists|1 or 0 |If //size// parameter is "M" or empty |1 if medium cover exists, 0 if not | | ||
| - | |response|medium_cover_url|URL |If //medium_cover_exists// is 1, this parameter includes displays cover URL|If //medium_cover_exists// is 1, this parameter includes displays cover URL| | ||
| - | |response|large_cover_exists|1 or 0 |If //size// parameter is "L" or empty|1 if large cover exists, 0 if not | | ||
| - | |response|large_cover_url |URL |If //large_cover_exists// is 1, this parameter includes displays cover URL |If //large_cover_exists// is 1, this parameter includes displays cover URL | | ||
| - | |**Block //response// ends**| | | | | | ||
| - | |||
| - | **XML input example:** | ||
| - | <code> | ||
| - | http://content.chilifresh.com/api/?isbn=9780578033440&size=L | ||
| - | </code> | ||
| - | |||
| - | **XML output example:** | ||
| - | <code> | ||
| - | <response> | ||
| - | <response_code>1</response_code> | ||
| - | <response_description>Response OK</response_description> | ||
| - | <response_time>Thu, 30 Jun 2011 07:25:58 -0500</response_time> | ||
| - | <item_id>9780578033440</item_id> | ||
| - | <small_cover_exists>1</small_cover_exists> | ||
| - | <small_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=S</small_cover_url> | ||
| - | <medium_cover_exists>1</medium_cover_exists> | ||
| - | <medium_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=M</medium_cover_url> | ||
| - | <large_cover_exists>1</large_cover_exists> | ||
| - | <large_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=L</large_cover_url> | ||
| - | </response> | ||
| - | </code> | ||
| - | ---- | ||
| - | |||
| - | **JSON input example:** | ||
| - | <code> | ||
| - | http://content.chilifresh.com/api/json/?isbn=9780578033440&size=L | ||
| - | </code> | ||
| - | |||
| - | **JSON output example:** | ||
| - | <code> | ||
| - | {"response": | ||
| - | { | ||
| - | "response_code":"1", | ||
| - | "response_description":"Response OK", | ||
| - | "response_time":"Thu, 30 Jun 2011 08:05:30 -0500", | ||
| - | "item_id":"9780578033440","small_cover_exists":"1", | ||
| - | "small_cover_url":"http:\/\/content.chilifresh.com\/?isbn=9780578033440&size=S", | ||
| - | "medium_cover_exists":"1", | ||
| - | "medium_cover_url":"http:\/\/content.chilifresh.com\/?isbn=9780578033440&size=M", | ||
| - | "large_cover_exists":"1", | ||
| - | "large_cover_url":"http:\/\/content.chilifresh.com\/?isbn=9780578033440&size=L" | ||
| - | } | ||
| - | } | ||
| - | </code> | ||
keysapi.txt ยท Last modified: 2012/04/22 04:54 (external edit)
Page Tools
