Authorization
To work with the public Api first go to the Project Settings page in the Livingdocs Editor and create an AccessToken
.
Embed the AccessToken
in the header of every HTTP request as shown below.
Request HTTP headers
Accept: application/json
Authorization: Bearer ey1234
Auth Example with Curl
ACCESS_TOKEN=ey1234
curl -k -X GET "http://localhost:9090/api/v1/project"
-H "Accept: application/json"
-H "Authorization: Bearer $ACCESS_TOKEN"
Auth Example with Axios
const axios = require('axios')
const token = 'ey1234'
const result = await axios.get('api/v1/project', {
baseURL: 'http://localhost:9090',
headers: {Authorization: `Bearer ${token}`},
timeout: 20000
})
Errors
Common error responses you can expect when working with the public Api.
Response
Response
Response
Base URL
This is the base Url you will need to interact with our API.
https://server.livingdocs.io/
Alternatively speed up your development process using our Software Development Kit.
My First Response
For testing purposes, you can go and run the following code snippet in your Terminal.
Don’t forget to replace your token.