Difference between revisions of "Getting Started"

From Advice Local Wiki
Jump to: navigation, search
(Sample Request)
(Products)
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== API Endpoint ==
 
== API Endpoint ==
 
http://p.lssdev.com
 
http://p.lssdev.com
 +
 +
The Advice Local API is organized around REST and JSON is returned by all API responses.
  
 
== Authentication ==
 
== Authentication ==
In order to interact with the Advice Local API, you must include your API token for each request.
+
In order to interact with the Advice Local API, you must include your API key for each request.
  
==== Sample Request ====
+
=== Example Request ===
 
<syntaxhighlight lang="php">
 
<syntaxhighlight lang="php">
GET /legacyclients/3199377 HTTP/1.1
+
GET /legacyclients/3201926 HTTP/1.1
 
Host: p.lssdev.com
 
Host: p.lssdev.com
 
x-api-token: YOUR_API_KEY
 
x-api-token: YOUR_API_KEY
 
Content-Type: application/json
 
Content-Type: application/json
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
YOUR_API_KEY - your secret API key.
  
 
== 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) {
Line 26: Line 29:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
== Clients ==
 +
[[Clients]]
 +
== Orders ==
 +
[[Orders]]
 +
== Reports ==
 +
[[Reports]]
 +
== Products ==
 +
[[Products]]
 +
 +
== Scores ==
 +
[[Scores]]

Latest revision as of 14:40, 1 December 2020

API Endpoint

http://p.lssdev.com

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

Clients

Clients

Orders

Orders

Reports

Reports

Products

Products

Scores

Scores