Skip to main content
MindTouch Success Center

Getting Started with the API

Applies to:
All MindTouch Versions
Role required:
Admin
If you are looking to extend the functionality of your MindTouch site into other systems, this article explains the basics of the MindTouch API.

Why do I Need the API?

MindTouch provides out of the box, easily configurable, integrations in the form of Touchpoints. Touchpoints extend your content into other web applications, CRM's, or websites. However, MindTouch can integrate with applications and systems without a web presentation, such as voice assistants and IoT devices. In addition, integrations with publishing automation systems, user management, and translation management systems can be desirable when MindTouch becomes a critical piece of your organization's business. 

These types of integrations typically require more complexity and application programming skills. While the MindTouch API can be easy to use to quickly fetch or update content on the fly, it's value is realized when integrations unlock the ability to extend MindTouch functionality into key parts of an organization.

Technical Details

The MindTouch API is organized around REST, and is located at the /@api/deki relative URL on a MindTouch site.

https://example.com/@api/deki

Every resource on the MindTouch site (pages, users, groups, etc.) is available through the API. Authenticated MindTouch site users can access the API, through the web browser, once they have signed into the MindTouch site. System and application integrations require the use of API tokens to access the API.

The default HTTP response content type is application/xml; charset=utf-8, but an application/json; charset=utf-8 response is possible if API requests include a dream.out.format=json HTTP query parameter.

// XML-encoded response
https://example.com/@api/deki/pages/{id}/info

// JSON-encoded response
https://example.com/@api/deki/pages/{id}/info?dream.out.format=json

Development Guides

There are two primary development guides for integrating with the MindTouch API: one for server applications (written in application server languages such as C#, Java, and PHP), and another for web browser applications (such as those written in JavaScript and executed in the web browser).

Creating server integrations with the MindTouch API
Create integrations between the MindTouch API and server applications, IoT devices, bots, or anything that can communicate over HTTPS.
Pages: 5
Creating web browser integrations with the MindTouch API
Create integrations between the MindTouch API and websites, web applications, Google Chrome apps, or simply anything that runs in a web browser.
Pages: 5

 

  • Was this article helpful?