Difference between revisions of "Getting Started"
From Advice Local Wiki
(→Example Request) |
(→Errors) |
||
| Line 16: | Line 16: | ||
== Errors == | == Errors == | ||
Any time the API engine throws an exception, the REST web service will catch the exception and return false with a message relaying what the error was and success = "false". | Any time the API engine throws an exception, the REST web service will catch the exception and return false with a message relaying what the error was and success = "false". | ||
| − | + | === Example Response === | |
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
array(3) { | array(3) { | ||
Revision as of 01:02, 16 December 2017
API Endpoint
Authentication
In order to interact with the Advice Local API, you must include your API token for each request.
Example Request
GET /legacyclients/3201926 HTTP/1.1
Host: p.lssdev.com
x-api-token: YOUR_API_KEY
Content-Type: application/json
YOUR_API_KEY - your secret API key.
Errors
Any time the API engine throws an exception, the REST web service will catch the exception and return false with a message relaying what the error was and success = "false".
Example Response
array(3) {
["success"]=>
bool(false)
["data"]=>
NULL
["error"]=>
string(57) "Sorry, there was an error while trying to run your query."
}
