Using Keys API you can generate and manipulate ChiliFresh Reviews API keys. It has output available in XML and JSON.
Parameter | Type (size) | Mandatory | Description |
account | Integer (10) | Yes | ChiliFresh library account ID |
Block | Element | Type (size) | Exists | Description |
Block response starts | Always | |||
response | response_code | Integer (1) | Always | See reference below |
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) | If successful request | 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:
https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=generateKey
JSON output example:
{"response": {"response_code":"100", "response_description":"API key generated", "response_time":"Fri, 05 Aug 2011 20:29:41", "api_key":"80db3274f63128835425145be21311c4"} }
Response code | Response description |
100 | API key generated |
101 | API key generating error |
Parameter | Type (size) | Mandatory | Description |
account | Integer (10) | Yes | ChiliFresh library account ID |
api_key | Varchar (32) | Yes | Valid API key |
Block | Element | Type (size) | Exists | Description |
Block response starts | Always | |||
response | response_code | Integer (1) | Always | See reference below |
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) | If successful request | Reviews API key |
Block response ends |
XML input example:
https://secure.chilifresh.com/api/generatekey/?account=1234&action=destroyKey&api_key=90a8s0d98a09s8d90a8s0d8
XML output example:
<response> <response_code>200</response_code> <response_description>API key destroyed</response_description> <response_time>Fri, 05 Aug 2011 20:26:12</response_time> <api_key>492450b3d1a94c136887cef5c317713f</api_key> </response>
JSON input example:
https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=destroyKey&api_key=90a8s0d98a09s8d90a8s0d8
JSON output example:
{"response": {"response_code":"200", "response_description":"API key destroyed", "response_time":"Fri, 05 Aug 2011 20:29:41", "api_key":"80db3274f63128835425145be21311c4"} }
Response code | Response description |
200 | API key destroyed |
201 | Invalid API key |
202 | API key destroy error |
Parameter | Type (size) | Mandatory | Description |
account | Integer (10) | Yes | ChiliFresh library account ID |
api_key | Varchar (32) | Yes | Valid API key |
Block | Element | Type (size) | Exists | Description |
Block response starts | Always | |||
response | response_code | Integer (1) | Always | See reference below |
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) | If successful request | Reviews API key |
Block response ends |
XML input example:
https://secure.chilifresh.com/api/generatekey/?account=1234&action=activateKey&api_key=asd90ais0d98a0s9d
XML output example:
<response> <response_code>300</response_code> <response_description>API key activated</response_description> <response_time>Fri, 05 Aug 2011 20:47:50</response_time> <api_key>80db3274f63128835425145be21311c4</api_key> </response>
JSON input example:
https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=activateKey&api_key=asd90ais0d98a0s9d
JSON output example:
{"response": {"response_code":"300", "response_description":"API key activated", "response_time":"Fri, 05 Aug 2011 20:50:20", "api_key":"80db3274f63128835425145be21311c4"} }
Response code | Response description |
300 | API key activated |
301 | API key already active |
302 | Invalid API key |
303 | API key activate error |
Parameter | Type (size) | Mandatory | Description |
account | Integer (10) | Yes | ChiliFresh library account ID |
Block | Element | Type (size) | Exists | Description |
Block response starts | Always | |||
response | response_code | Integer (1) | Always | See reference below |
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) | If successful request | Reviews API key |
Block response ends |
XML input example:
https://secure.chilifresh.com/api/generatekey/?account=1234&action=deactivateKey&api_key=asd90ais0d98a0s9d
XML output example:
<response> <response_code>400</response_code> <response_description>API key deactivated</response_description> <response_time>Fri, 05 Aug 2011 20:47:50</response_time> <api_key>80db3274f63128835425145be21311c4</api_key> </response>
JSON input example:
https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=deactivateKey&api_key=asd90ais0d98a0s9d
JSON output example:
{"response": {"response_code":"400", "response_description":"API key deactivated", "response_time":"Fri, 05 Aug 2011 20:50:20", "api_key":"80db3274f63128835425145be21311c4"} }
Response code | Response description |
400 | API key deactivated |
401 | API key already inactive |
402 | Invalid API key |
403 | API key deactivate error |
Error code | Error description |
0 | System error |
1 | Empty account ID |
2 | Action not specified |