User Tools

Site Tools


keysapi

This is an old revision of the document!


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

Parameters

ParameterType (size)MandatoryDescription
accountInteger (10)YesChiliFresh library account ID

Output

  • Format: XML, JSON
  • Blocks and elements:
Block Element Type (size)Exists Description
Block response startsAlways
responseresponse_codeInteger (1)AlwaysResponse code 1 - response OK, 0 - missing item ID
responseresponse_descriptionText (255)AlwaysBrief description of response code
responseresponse_timeDate&time (D, d M Y H:i:s -hhmm)AlwaysExample: Thu, 30 Jun 2010 07:25:58 -0500
responseapi_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 codes

Response code Response description
100API key generated
101API key generating error
keysapi.1312591072.txt.gz · Last modified: 2012/04/22 04:52 (external edit)