What is an API?
API stands for Application Programming Interface. The MindTouch API provides developers the ability to access under-the-hood MindTouch functions for programming purposes. You can find our documentation for all of our APIs here.
Are there requirements when using the MindTouch API?
MindTouch API usage requires a MindTouch Enterprise license. Most API calls also require authentication, either in the form of user sign in, or an API token.
Do I need to have programming experience to use the MindTouch API?
Previous experience with programming and API use is required to utilize the MindTouch API. The MindTouch API is REST based, and is programming language independent. Your developers can utilize any programming language which supports REST based APIs to create custom applications which interact with MindTouch data.
How or when could my organization use the MindTouch API?
The MindTouch API allows developers to access page content, site tags, and user information programmatically. In short, any functionality shown in our user interface is available within the API.
What are the most common uses of the MindTouch API?
Some of the most common uses of the MindTouch API are integrating a Single Sign-On solution, exporting and importing content to MindTouch, and exposing MindTouch data into a custom application.
What changes can I expect to see over time to a basic GET request for an object in the MindTouch schema? How will the contract change?
The only changes that may occur would be limited to the addition of data or parameters. For example, we could add a field called Title for a user or a sortby parameter. We do not remove elements from the API. We will very rarely decommission an API (once every 2 years) due to non-utilization. This, of course, would be announced well in advance (4 weeks) of the decommission event.
Is there a published SDK? In what languages?
MindTouch does not have official software development kits (SDKs). You can integrate with MindTouch through our REST API endpoints which are accessible in any development language. We do have code snippet examples to help you get acquainted with using a REST API, but most modern day development environments will make it extremely easy to POST, GET, DELETE, and PUT to the MindTouch API. For convenience we also link to unsupported open source MindTouch API clients on GitHub:
These clients are not supported or covered through MindTouch support plans. They can be used at your own risk in your API integrations or examined to discover how the API can be called.
What throttling or other guardrails are in place for the API?
We do not throttle the API; however, we do monitor all traffic and subsequent database requests to identify spikes, abnormalities, and opportunities for enhancement. Because we can analyze API traffic information across thousands of customers, we can fine-tune the API in ways that are beneficial to everyone. Though we do not limit the number of API calls you can make, we do monitor them. If your usage exceeds your license, your Account Executive will contact you about purchasing additional bandwidth.
Does the API support event triggers or another mechanism for real-time notification?
All MindTouch APIs are updated in real time. If you wanted to trigger events from the MindTouch API, you would simply need to monitor your desired APIs for certain events. This capability would not be built into the API.
What is the sunsetting policy for deprecated APIs?
While this is very rare, we do occasionally deprecate an API. Before submitting a request to deprecate an API, the engineer creates a usage report to identify the scale and identity of utilization. Generally speaking, we would not deprecate an API that is being used.