Reply to thread

Message

<blockquote data-quote="Chris D" data-source="post: 1293106" data-attributes="member: 11388">Accessing the APIThe API for a particular installation is always found at [icode]&lt;XF url&gt;/api/[/icode]. (Note that to ensure consistent URLs, the API always uses the &quot;friendly URL&quot; style.) All routes will be accessed under this URL.The API key you generated must be passed in via a custom [icode]XF-Api-Key[/icode] header added to your request.If you are using a super user key, you may pass the user ID of the effective user via the [icode]XF-Api-User[/icode] header; if you don't pass any user in, the request will default to acting as a guest.Further request parameters may be sent via the query string or a [icode]application/x-www-form-urlencoded[/icode] body. (Note: [icode]multipart/form-data[/icode] is also supported, but for POST requests only.)By default, all requests will respect user permissions. Super user keys may bypass this on a request-by-request basis by setting the [icode]api_bypass_permissions[/icode] parameter to 1.The API always responds with JSON. Errors will always return a response code in the 400 range. Successful requests will return a 200 code. While not commonly used, redirects will return a 300-range code.Errors always take a standard form. Here's an example:[code=json]{&nbsp; &nbsp; &quot;errors&quot;: [&nbsp; &nbsp; &nbsp; &nbsp; {&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &quot;code&quot;: &quot;api_key_not_found&quot;,&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &quot;message&quot;: &quot;API key provided in request was not found.&quot;,&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &quot;params&quot;: []&nbsp; &nbsp; &nbsp; &nbsp; }&nbsp; &nbsp; ]}[/code]Note that more than one error may be returned (such as if you have multiple errors when creating a thread).In most cases, the error code is the name of the phrase used by the error. The message itself may change and should not be used for automated processing.For successful requests, the response data will vary by route, so let's talk more about the routes...</blockquote>

[QUOTE="Chris D, post: 1293106, member: 11388"] [SIZE=6][B]Accessing the API[/B][/SIZE] The API for a particular installation is always found at [icode]<XF url>/api/[/icode]. (Note that to ensure consistent URLs, the API always uses the "friendly URL" style.) All routes will be accessed under this URL. The API key you generated must be passed in via a custom [icode]XF-Api-Key[/icode] header added to your request. If you are using a super user key, you may pass the user ID of the effective user via the [icode]XF-Api-User[/icode] header; if you don't pass any user in, the request will default to acting as a guest. Further request parameters may be sent via the query string or a [icode]application/x-www-form-urlencoded[/icode] body. (Note: [icode]multipart/form-data[/icode] is also supported, but for POST requests only.) By default, all requests will respect user permissions. Super user keys may bypass this on a request-by-request basis by setting the [icode]api_bypass_permissions[/icode] parameter to 1. The API always responds with JSON. Errors will always return a response code in the 400 range. Successful requests will return a 200 code. While not commonly used, redirects will return a 300-range code. Errors always take a standard form. Here's an example: [code=json] { "errors": [ { "code": "api_key_not_found", "message": "API key provided in request was not found.", "params": [] } ] } [/code] Note that more than one error may be returned (such as if you have multiple errors when creating a thread). In most cases, the error code is the name of the phrase used by the error. The message itself may change and should not be used for automated processing. For successful requests, the response data will vary by route, so let's talk more about the routes... [/QUOTE]

Verification