The workflow to authentify is based on Oauth2 protocol. To have access to Domoscio functionalities the user should follow these steps:

• AuthorizationToken:
  

  The AuthorizationToken is given to the user when he starts working with the Domoscio API. This token must remain secret.

  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.

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

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.

A KnowledgeNode (KN) is the second object to instantiate while setting up your content on our API. It is the central model of the application; it can be linked to multiple KnowledgeGraphs. You can use it to describe your content architecture, i.e skills, knowledges, know-hows, etc.