Domoscio API (v2.6.0)

We designed the Domoscio API in a Restful way, so that your user experience is simple and straightforward.

You will find in this documentation all the information necessary to interact with the API.

To keep in touch with the latest developments, check the Changelog just here!

Authentication

The workflow to authentify is based on Oauth2 protocol. The AuthorizationToken is given to the user when he starts working with the Domoscio API. This token must remain secret. To have access to Domoscio functionalities the user should follow these steps:

  1. The AuthorizationToken should be used inside the Header of the request when calling the API for the first time & when the RefreshToken expires:
    Authorization: Bearer < AuthorizationToken >

  2. Inside the response Header, the AccessToken and RefreshToken will be given:
    AccessToken: < AccessToken >
    RefreshToken: < RefreshToken >

  3. The RefreshToken should now be used in the header of the API request with the AccessToken. Here is an example on how to retrieve the AccessToken & RefreshToken:

  • Note: You will receive the AccessToken in the response at every request. However, when the RefreshToken is expired, you will receive a 401 error. At this point, it will be necessary to reuse the AuthenticationToken to retrieve a new pair of RefreshToken / AccessToken.

Response Status

Domoscio API uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

  • Codes in the 2xx range indicate success.
  • Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).
  • Codes in the 5xx range indicate an error with Domoscio's servers (Refer to the Domoscio Support in this case).
HTTP Status Code Description
200 - OK Everything worked as expected.
400 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid Authentication Token provided.
404 - Not Found The requested resource doesn't exist.
422 - Unprocessable Entity The parameters were valid but the request failed, often due to already existing Objects with the input parameters.
500, 502, 503, 504 - Server Errors Something went wrong on Domoscio API's end. Please contact the Domoscio support.

KnowledgeGraph

A KnowledgeGraph (KG) is the first object to instantiate while setting up your content on our API. It is the top level of aggregation for knowledge nodes and edges. You can use it to describe your course, a book or even your whole knowledge map.

Create KnowledgeGraph

Create KnowledgeGraphs with payload parameters

Request Body schema: application/json
name
string

Object name.

uid
string

Object UID.

Responses