Domoscio Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===Use our REST API===
We designed the Domoscio API in a Restful way, so that your user experience is simple and straightforward. You are able to:
  * Submit data requires an HTTP POST request
  * Retrieve data requires an HTTP GET request
  * Change data requires an HTTP PUT request
Requests must be sent using content-type «application/json». The request and response body encoding is always UTF-8.\\
We use a pagination system, in case the response to your GET request is too heavy. You can ask the pagination to order the items thanks to : their ID, the creation date or the last change date, in ascending or descending order. To do this, you can send the following parameters to your request :\\

^ Parameter name ^ Possible values ^   Description  ^
| order_by | id\\ created_at\\ updated_at | the ordering criteria is either the unique identifier on Domoscio's API database, the date of creation, of the date of the last update | 
| order | ascending\\ descending | ascending : the smallest values come first \\ descending : the biggest values come first | 
| page | integer | Number of the page you want to view; 1 by default | 

===Create Sandbox Account===
Simply ask us to create your credentials.\\
Now that you have your authentication keys, let us see how to properly authenticate your application to our API.

===Authenticate your app===
We provide two ways to authenticate and communicate with the service:
  * Basic Access Authentication is a fast way to implement our API.
  * LTI / OAuth.

==With Authorization header==
We use a standard Basic Access Authentication.
The Authorization header is constructed as follows:
{{api2:authenticate_header.jpg}}

==With URL parameters==
You can also pass your authentication key as a token in the URL to authenticate your application:
{{api2:authenticate_URL.jpg}}


===Create Production Account===
Get in touch with our IT service whenever you feel ready to go live. We will arrange the setup and get back to you with the details.

===How to construct URLs to access your API environment===
Once your application is authenticated, accessing to your own environment is really simple. All the urls must be constructed as follows:

''[HOST_URL]/[API_VERSION]/instances/[YOUR_INSTANCE_ID]/[ACTION]''

A list of all the actions can be found in this document.
The [API_VERSION] is currently “v2” and [HOST_URL] is “http://adaptive-engine.domoscio.com”.
Domoscio Docs

User Tools

Site Tools

Page Tools
