User Tools

Site Tools


api1:getting_started

**This is an old revision of the document!** ----

A PCRE internal error occured. This might be caused by a faulty plugin

===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.\\ You can create a sandbox account to start working with the API. Go and visit us at [[http://domoscio-backend.domoscio.com|http://domoscio-backend.domoscio.com]] ===Create Sandbox Account=== Go online and browse for [[http://domoscio-backend.domoscio.com|http://domoscio-backend.domoscio.com]]. ===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 “v1” and [HOST_URL] is “domoscio-backend.domoscio.com” for European end points.

api1/getting_started.1508169987.txt.gz · Last modified: 2017/10/16 18:06 by maries