This shows you the differences between two versions of the page.
Next revision | Previous revision Next revision Both sides next revision | ||
covers:api [2011/06/30 07:54] jposeika created |
covers:api [2011/06/30 08:17] jposeika [Output] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Covers (RESTful) API ====== | ====== Covers (RESTful) API ====== | ||
- | Using Reviews API you can implement reviews into your library's OPAC, web page, iPhone app or anywhere else. It has output available in XML and JSON. | + | Using Covers API you can retrieve data on ChiliFresh covers. It has output available in XML and JSON. |
- | ====== User functions ====== | + | ===== Covers availability data ===== |
==== Input ==== | ==== Input ==== | ||
* URL for XML output: https://content.chilifresh.com/api/ | * URL for XML output: https://content.chilifresh.com/api/ | ||
+ | * URL for JSON output: https://content.chilifresh.com/api/json/ | ||
* Method: GET | * Method: GET | ||
- | * Parameters: | + | ==== Parameters ==== |
|**Parameter**|**Type (size)**|**Mandatory**|**Description**| | |**Parameter**|**Type (size)**|**Mandatory**|**Description**| | ||
|isbn|Variable characters (20)|Yes|Item's ISBN, UPC or other ID| | |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.| | + | |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.| |
Line 23: | Line 24: | ||
|response|response_description|Text (255)|Always|Brief description of response code| | |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|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|ISBN, UPC or other item ID| | + | |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_exists|1 or 0|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|small_cover_url|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|medium_cover_exists|1 or 0|1 if medium cover exists, 0 if not| | + | |response|large_cover_exists|1 or 0|If //size// parameter is "L" or empty|1 if large cover exists, 0 if not| |
- | |response|medium_cover_url|URL|If //medium_cover_exists// is 1, this parameter includes displays cover URL| | + | |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| |
- | + | ||
- | + | ||
- | |response|large_cover_exists|1 or 0|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| | + | |
|**Block //response// ends**| | | | | | |**Block //response// ends**| | | | | | ||
+ | **XML input example:** | ||
+ | <code> | ||
+ | http://content.chilifresh.com/api/?isbn=9780578033440&size=L | ||
+ | </code> | ||
**XML output example:** | **XML output example:** | ||
Line 46: | Line 45: | ||
<response_time>Thu, 30 Jun 2011 07:25:58 -0500</response_time> | <response_time>Thu, 30 Jun 2011 07:25:58 -0500</response_time> | ||
<item_id>9780578033440</item_id> | <item_id>9780578033440</item_id> | ||
- | |||
<small_cover_exists>1</small_cover_exists> | <small_cover_exists>1</small_cover_exists> | ||
<small_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=S</small_cover_url> | <small_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=S</small_cover_url> | ||
- | |||
<medium_cover_exists>1</medium_cover_exists> | <medium_cover_exists>1</medium_cover_exists> | ||
<medium_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=M</medium_cover_url> | <medium_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=M</medium_cover_url> | ||
- | |||
<large_cover_exists>1</large_cover_exists> | <large_cover_exists>1</large_cover_exists> | ||
<large_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=L</large_cover_url> | <large_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=L</large_cover_url> | ||
</response> | </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> | </code> |