Difference between revisions of "Getting Started"
From Advice Local Wiki
(→API Endpoint) |
(→Example Response) |
||
| Line 29: | Line 29: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | == Clients == | |
[[Clients]] | [[Clients]] | ||
| − | + | == Orders == | |
[[Orders]] | [[Orders]] | ||
| − | + | == Reports == | |
[[Reports]] | [[Reports]] | ||
| − | + | == Products == | |
[[Products]] | [[Products]] | ||
| − | + | == Directories == | |
[[Directories]] | [[Directories]] | ||
Revision as of 14:38, 18 December 2017
Contents
API Endpoint
The Advice Local API is organized around REST and JSON is returned by all API responses.
Authentication
In order to interact with the Advice Local API, you must include your API key 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."
}
