Get Started

Authorization

Description

To work with the Public API first go to the Project Settings page in the Livingdocs Editor and create an AccessToken. The token is scoped to the project so make sure you create the token in the correct project.

Project admins can create new AccessToken by going to Menu > Preferences > Project Admin, from the project landing page. On the sidebar, go to Api Clients and start the token creation flow with Add Api Client on the right.

In the create token dialog, you can set the name of the token, description (optional), expiration date and permissions. You can click Create to generate the token with the chosen permissions. The token will be generated and you can copy it to your clipboard.

Embed the AccessToken in the header of every HTTP request as shown below.

Base URL

This is the base Url you will need to interact with our API.

https://server.livingdocs.io/

Request HTTP headers

Authorization: Bearer ey1234

Auth Example with Curl

ACCESS_TOKEN=ey1234
curl -k -X GET "http://localhost:9090/api/:apiVersion/project"
  -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
})

Common Errors

Description

Common error responses you can expect when working with the public Api.

Response

401

Unauthorized

{
  "status": 401,
  "error": "Unauthorized",
  "error_details": {
    "access_token": "The access token expired."
  }
}

403

Forbidden

{
  "status": 403,
  "error": "Forbidden",
  "error_details": {
    "access_token": "The request requires higher privileges"
  }
}

404

Not Found

{
  "status": 404,
  "error": "Not Found",
  "error_details": {
    "url": "/api/v1/foo"
  }
}

Get your First Response

Description

For testing purposes, you can go and run the following code snippet in your Terminal.

Don’t forget to replace your token.

Curl Example

curl -k -X GET https://server.livingdocs.io/api/v1/documents/latestPublications \
  -H "Authorization: Bearer your_token"

Response

200

[
  {
    "systemdata": {
      "projectId": 1,
      "channelId": 1,
      "documentId": 1,
      "contentType": "article",
      "documentType": "article",
      "publicationId": 1,
      "firstPublicationDate": "2022-03-16T14:08:11:000Z",
      "significantPublicationDate": "2022-10-26T07:25:00.000Z",
      "visiblePublicationDate": "2022-10-27T06:00:00.000Z",
      "lastPublicationDate": "2023-03-18T16:32:04.170Z",
      "design": {
        "name": "timeline",
        "version": "1.1.0"
      }
    },
    "metadata": {
      "title": "a title",
      "description": "some lead",
      "dependencies": {}
    },
    "content": [
      {
        "id": "doc-1b8i1ksh10",
        "component": "head",
        "identifier": "timeline.head",
        "content": {
          "title": "a title",
          "text": "some lead"
        }
      },
      {
        "id": "doc-1b8i1ksh20",
        "component": "normal",
        "identifier": "timeline.normal",
        "content": {
          "caption": "my caption"
        },
        "styles": {
          "position": "left"
        }
      },
      {
        "id": "doc-1b8i1ksh30",
        "component": "p",
        "identifier": "timeline.p",
        "content": {
          "text": "first paragraph"
        }
      },
      {
        "id": "doc-1b8i1me1d0",
        "component": "p",
        "identifier": "timeline.p",
        "content": {
          "text": "second paragraph"
        }
      }
    ]
  }
]