keysapi
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
keysapi [2011/08/05 19:42] jposeika [Parameters] |
keysapi [2012/04/22 04:54] (current) |
||
|---|---|---|---|
| Line 19: | Line 19: | ||
| |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | ||
| |**Block //response// starts**|||Always| | | |**Block //response// starts**|||Always| | | ||
| - | |response|response_code|Integer (1)|Always|Response code 1 - response OK, 0 - missing item ID| | + | |response|response_code|Integer (1)|Always|See reference below| |
| |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| | ||
| Line 77: | Line 77: | ||
| |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | ||
| |**Block //response// starts**|||Always| | | |**Block //response// starts**|||Always| | | ||
| - | |response|response_code|Integer (1)|Always|Response code 1 - response OK, 0 - missing item ID| | + | |response|response_code|Integer (1)|Always|See reference below| |
| |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| | ||
| Line 85: | Line 85: | ||
| **XML input example:** | **XML input example:** | ||
| <code> | <code> | ||
| - | https://secure.chilifresh.com/api/generatekey/?account=1234&action=generateKey | + | https://secure.chilifresh.com/api/generatekey/?account=1234&action=destroyKey&api_key=90a8s0d98a09s8d90a8s0d8 |
| </code> | </code> | ||
| Line 91: | Line 91: | ||
| <code> | <code> | ||
| <response> | <response> | ||
| - | <response_code>100</response_code> | + | <response_code>200</response_code> |
| - | <response_description>API key generated</response_description> | + | <response_description>API key destroyed</response_description> |
| <response_time>Fri, 05 Aug 2011 20:26:12</response_time> | <response_time>Fri, 05 Aug 2011 20:26:12</response_time> | ||
| <api_key>492450b3d1a94c136887cef5c317713f</api_key> | <api_key>492450b3d1a94c136887cef5c317713f</api_key> | ||
| Line 101: | Line 101: | ||
| **JSON input example:** | **JSON input example:** | ||
| <code> | <code> | ||
| - | https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=generateKey | + | https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=destroyKey&api_key=90a8s0d98a09s8d90a8s0d8 |
| </code> | </code> | ||
| Line 107: | Line 107: | ||
| <code> | <code> | ||
| {"response": | {"response": | ||
| - | {"response_code":"100", | + | {"response_code":"200", |
| - | "response_description":"API key generated", | + | "response_description":"API key destroyed", |
| "response_time":"Fri, 05 Aug 2011 20:29:41", | "response_time":"Fri, 05 Aug 2011 20:29:41", | ||
| "api_key":"80db3274f63128835425145be21311c4"} | "api_key":"80db3274f63128835425145be21311c4"} | ||
| Line 116: | Line 116: | ||
| ==== Response codes ==== | ==== Response codes ==== | ||
| |**Response code** |**Response description** | | |**Response code** |**Response description** | | ||
| - | |100|API key generated| | + | |200|API key destroyed| |
| - | |101|API key generating error| | + | |201|Invalid API key| |
| + | |202|API key destroy error| | ||
| ===== activateKey call ===== | ===== activateKey call ===== | ||
| Line 128: | Line 128: | ||
| |**Parameter**|**Type (size)**|**Mandatory**|**Description**| | |**Parameter**|**Type (size)**|**Mandatory**|**Description**| | ||
| |account|Integer (10)|Yes|ChiliFresh library account ID| | |account|Integer (10)|Yes|ChiliFresh library account ID| | ||
| - | + | |api_key|Varchar (32)|Yes|Valid API key| | |
| ==== Output ==== | ==== Output ==== | ||
| * Format: XML, JSON | * Format: XML, JSON | ||
| Line 136: | Line 135: | ||
| |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | ||
| |**Block //response// starts**|||Always| | | |**Block //response// starts**|||Always| | | ||
| - | |response|response_code|Integer (1)|Always|Response code 1 - response OK, 0 - missing item ID| | + | |response|response_code|Integer (1)|Always|See reference below| |
| |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| | ||
| Line 144: | Line 143: | ||
| **XML input example:** | **XML input example:** | ||
| <code> | <code> | ||
| - | https://secure.chilifresh.com/api/generatekey/?account=1234&action=generateKey | + | https://secure.chilifresh.com/api/generatekey/?account=1234&action=activateKey&api_key=asd90ais0d98a0s9d |
| </code> | </code> | ||
| Line 150: | Line 149: | ||
| <code> | <code> | ||
| <response> | <response> | ||
| - | <response_code>100</response_code> | + | <response_code>300</response_code> |
| - | <response_description>API key generated</response_description> | + | <response_description>API key activated</response_description> |
| - | <response_time>Fri, 05 Aug 2011 20:26:12</response_time> | + | <response_time>Fri, 05 Aug 2011 20:47:50</response_time> |
| - | <api_key>492450b3d1a94c136887cef5c317713f</api_key> | + | <api_key>80db3274f63128835425145be21311c4</api_key> |
| </response> | </response> | ||
| </code> | </code> | ||
| Line 160: | Line 159: | ||
| **JSON input example:** | **JSON input example:** | ||
| <code> | <code> | ||
| - | https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=generateKey | + | https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=activateKey&api_key=asd90ais0d98a0s9d |
| </code> | </code> | ||
| Line 166: | Line 165: | ||
| <code> | <code> | ||
| {"response": | {"response": | ||
| - | {"response_code":"100", | + | {"response_code":"300", |
| - | "response_description":"API key generated", | + | "response_description":"API key activated", |
| - | "response_time":"Fri, 05 Aug 2011 20:29:41", | + | "response_time":"Fri, 05 Aug 2011 20:50:20", |
| - | "api_key":"80db3274f63128835425145be21311c4"} | + | "api_key":"80db3274f63128835425145be21311c4"} |
| } | } | ||
| </code> | </code> | ||
| Line 175: | Line 174: | ||
| ==== Response codes ==== | ==== Response codes ==== | ||
| |**Response code** |**Response description** | | |**Response code** |**Response description** | | ||
| - | |100|API key generated| | + | |300|API key activated| |
| - | |101|API key generating error| | + | |301|API key already active| |
| + | |302|Invalid API key| | ||
| + | |303|API key activate error| | ||
| ===== deactivateKey call ===== | ===== deactivateKey call ===== | ||
| Line 194: | Line 195: | ||
| |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | |**Block** |**Element** |**Type (size)**|**Exists** |**Description** | | ||
| |**Block //response// starts**|||Always| | | |**Block //response// starts**|||Always| | | ||
| - | |response|response_code|Integer (1)|Always|Response code 1 - response OK, 0 - missing item ID| | + | |response|response_code|Integer (1)|Always|See reference below| |
| |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| | ||
| Line 202: | Line 203: | ||
| **XML input example:** | **XML input example:** | ||
| <code> | <code> | ||
| - | https://secure.chilifresh.com/api/generatekey/?account=1234&action=generateKey | + | https://secure.chilifresh.com/api/generatekey/?account=1234&action=deactivateKey&api_key=asd90ais0d98a0s9d |
| </code> | </code> | ||
| Line 208: | Line 209: | ||
| <code> | <code> | ||
| <response> | <response> | ||
| - | <response_code>100</response_code> | + | <response_code>400</response_code> |
| - | <response_description>API key generated</response_description> | + | <response_description>API key deactivated</response_description> |
| - | <response_time>Fri, 05 Aug 2011 20:26:12</response_time> | + | <response_time>Fri, 05 Aug 2011 20:47:50</response_time> |
| - | <api_key>492450b3d1a94c136887cef5c317713f</api_key> | + | <api_key>80db3274f63128835425145be21311c4</api_key> |
| </response> | </response> | ||
| </code> | </code> | ||
| Line 218: | Line 219: | ||
| **JSON input example:** | **JSON input example:** | ||
| <code> | <code> | ||
| - | https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=generateKey | + | https://secure.chilifresh.com/api/generatekey/json/?account=1234&action=deactivateKey&api_key=asd90ais0d98a0s9d |
| </code> | </code> | ||
| Line 224: | Line 225: | ||
| <code> | <code> | ||
| {"response": | {"response": | ||
| - | {"response_code":"100", | + | {"response_code":"400", |
| - | "response_description":"API key generated", | + | "response_description":"API key deactivated", |
| - | "response_time":"Fri, 05 Aug 2011 20:29:41", | + | "response_time":"Fri, 05 Aug 2011 20:50:20", |
| - | "api_key":"80db3274f63128835425145be21311c4"} | + | "api_key":"80db3274f63128835425145be21311c4"} |
| } | } | ||
| </code> | </code> | ||
| - | |||
| ==== Response codes ==== | ==== Response codes ==== | ||
| |**Response code** |**Response description** | | |**Response code** |**Response description** | | ||
| - | |100|API key generated| | + | |400|API key deactivated| |
| - | |101|API key generating error| | + | |401|API key already inactive| |
| + | |402|Invalid API key| | ||
| + | |403|API key deactivate error| | ||
| ====== General errors ====== | ====== General errors ====== | ||
keysapi.1312591343.txt.gz · Last modified: 2012/04/22 04:52 (external edit)
Page Tools
