Introduction

The Integration API endpoints are intended to provide the data to bring content from Turtledocs into another system.

There are a few basic endpoints that allow you to list the topics, sub-topics, and content headlines, as well as the content itself.

Authorization

We use API Keys to allow access to the APIs. To generate a key, log into Turtledocs and go to ‘Site Management’ → ‘API Keys’.

The API Key should be included in any requests to the server, in a HTTP header like:

Authorization: {your-api-key}

Topics

This endpoint retrieves all Topics within your site, including subtopics and configuration data for each topic.

HTTP Request

GET https://turtledocs.com/integration/topics

Specific Topic

This endpoint retrieves a specific Topic, returning its subtopics, configuration data, and a list of all contents within that topic.

HTTP Request

GET https://turtledocs.com/integration/topic/{topic-key}

Parameters

• topic-key - The URL key for the topic to be retrieved. This is returned as topic.key from API endpoints, and is entered in the URL field when editing topics within the app.

Specific Subtopic

This endpoint retrieve the content within a specific subtopic.

HTTP Request

GET https://turtledocs.com/integration/topic/{topic-key}/{subtopic}

Parameters

• topic-key - The URL key for the topic to be retrieved. This is returned as topic.key from API endpoints, and is entered in the URL field when editing topics within the app.

• subtopic - The subtopic to be retrieved. This is returned as content.subtopic from API endpoints, and is selected from the Subtopic drop-down within the app when editing content.

Specific Content

This endpoint retrieves the title, subtitle, content, and metadata from a specific content document.

HTTP Request

GET https://turtledocs.com/integration/content/{docId}

Parameters

• docId - The ID of the document to be retrieved. It is returned as content.docId from API endpoints, and is entered in the Document URL field when editing content within the app.