ChiliFresh.com

User Tools

Site Tools

Trace:
keysapi

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
keysapi [2011/08/05 19:37]
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 60: Line 60:
 |100|API key generated| |100|API key generated|
 |101|API key generating error| |101|API key generating error|
 +
 +
 +===== destroyKey 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|Integer (10)|Yes|ChiliFresh library account ID|
 +|api_key|Varchar (32)|Yes|Valid API key|
 +==== Output ====
 +  * Format: XML, JSON
 +  * Blocks and elements:
 +
 +|**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:**
 +<​code>​
 +https://​secure.chilifresh.com/​api/​generatekey/?​account=1234&​action=destroyKey&​api_key=90a8s0d98a09s8d90a8s0d8
 +</​code>​
 +
 +**XML output example:**
 +<​code>​
 +<​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>​
 +</​code>​
 +----
 +
 +**JSON input example:**
 +<​code>​
 +https://​secure.chilifresh.com/​api/​generatekey/​json/?​account=1234&​action=destroyKey&​api_key=90a8s0d98a09s8d90a8s0d8
 +</​code>​
 +
 +**JSON output example:**
 +<​code>​
 +{"​response":​
 +            {"​response_code":"​200",​
 +             "​response_description":"​API key destroyed",​
 +             "​response_time":"​Fri,​ 05 Aug 2011 20:​29:​41",​
 +             "​api_key":"​80db3274f63128835425145be21311c4"​}
 +}
 +</​code>​
 +
 +==== Response codes ====
 +|**Response code** |**Response description** |
 +|200|API key destroyed|
 +|201|Invalid API key|
 +|202|API key destroy error|
 +
 +===== activateKey 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|Integer (10)|Yes|ChiliFresh library account ID|
 +|api_key|Varchar (32)|Yes|Valid API key|
 +==== Output ====
 +  * Format: XML, JSON
 +  * Blocks and elements:
 +
 +|**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:**
 +<​code>​
 +https://​secure.chilifresh.com/​api/​generatekey/?​account=1234&​action=activateKey&​api_key=asd90ais0d98a0s9d
 +</​code>​
 +
 +**XML output example:**
 +<​code>​
 +<​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>​
 +</​code>​
 +----
 +
 +**JSON input example:**
 +<​code>​
 +https://​secure.chilifresh.com/​api/​generatekey/​json/?​account=1234&​action=activateKey&​api_key=asd90ais0d98a0s9d
 +</​code>​
 +
 +**JSON output example:**
 +<​code>​
 +{"​response":​
 +            {"​response_code":"​300",​
 +            "​response_description":"​API key activated",​
 +            "​response_time":"​Fri,​ 05 Aug 2011 20:​50:​20",​
 +            "​api_key":"​80db3274f63128835425145be21311c4"​}
 +}
 +</​code>​
 +
 +==== Response codes ====
 +|**Response code** |**Response description** |
 +|300|API key activated|
 +|301|API key already active|
 +|302|Invalid API key|
 +|303|API key activate error|
 +
 +===== deactivateKey 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|Integer (10)|Yes|ChiliFresh library account ID|
 +
 +
 +==== Output ====
 +  * Format: XML, JSON
 +  * Blocks and elements:
 +
 +|**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:**
 +<​code>​
 +https://​secure.chilifresh.com/​api/​generatekey/?​account=1234&​action=deactivateKey&​api_key=asd90ais0d98a0s9d
 +</​code>​
 +
 +**XML output example:**
 +<​code>​
 +<​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>​
 +</​code>​
 +----
 +
 +**JSON input example:**
 +<​code>​
 +https://​secure.chilifresh.com/​api/​generatekey/​json/?​account=1234&​action=deactivateKey&​api_key=asd90ais0d98a0s9d
 +</​code>​
 +
 +**JSON output example:**
 +<​code>​
 +{"​response":​
 +            {"​response_code":"​400",​
 +            "​response_description":"​API key deactivated",​
 +            "​response_time":"​Fri,​ 05 Aug 2011 20:​50:​20",​
 +            "​api_key":"​80db3274f63128835425145be21311c4"​}
 +}
 +</​code>​
 +==== Response codes ====
 +|**Response code** |**Response description** |
 +|400|API key deactivated|
 +|401|API key already inactive|
 +|402|Invalid API key|
 +|403|API key deactivate error|
 +
 +====== General errors ======
 +|**Error code** |**Error description** |
 +|0|System error|
 +|1|Empty account ID|
 +|2|Action not specified|
keysapi.1312591072.txt.gz ยท Last modified: 2012/04/22 04:52 (external edit)

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki