keysapi
This is an old revision of the document!
Table of Contents
Keys (RESTful) API
Using Keys API you can generate and manipulate ChiliFresh Reviews API keys. It has output available in XML and JSON.
generateKey call
Input
- URL for XML output: https://secure.chilifresh.com/api/generatekey/
- URL for JSON output: https://secure.chilifresh.com/api/generatekey/json/
- Method: GET
Parameters
| Parameter | Type (size) | Mandatory | Description |
| account | Variable characters (20) | Yes | Item's ISBN, UPC or other ID |
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 | api_key | VARCHAR(32) | Reviews API key | |
| Block response ends | ||||
XML input example:
https://secure.chilifresh.com/api/generatekey/?account=1234&action=generateKey
XML output example:
<response>
<response_code>100</response_code>
<response_description>API key generated</response_description>
<response_time>Fri, 05 Aug 2011 20:26:12</response_time>
<api_key>492450b3d1a94c136887cef5c317713f</api_key>
</response>
JSON input example:
http://content.chilifresh.com/api/json/?isbn=9780578033440&size=L
JSON output example:
{"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"
}
}
keysapi.1312590431.txt.gz · Last modified: 2012/04/22 04:52 (external edit)
