Getting Started

From Advice Local Wiki
Revision as of 11:17, 12 December 2017 by Psu (talk | contribs) (Sample Request)
Jump to: navigation, search

API Endpoint

http://p.lssdev.com

Authentication

In order to interact with the Advice Local API, you must include your API token for each request.

Sample Request

GET /legacyclients/3199377 HTTP/1.1
Host: p.lssdev.com
x-api-token: pk_3d5e01ef4ef113a158bcce657af6f1cd
Content-Type: application/json
Cache-Control: no-cache

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".

array(3) {
  ["success"]=>
  bool(false)
  ["data"]=>
  NULL
  ["error"]=>
  string(57) "Sorry, there was an error while trying to run your query."
}