Summary
The MindBridge Application Programming Interface (“API”) allows you to control permissions and access to various aspects of your MindBridge tenant, including libraries, organizations, engagements, and analyses.
With the API, you can securely push files from your ERP directly into the file manager, import the data into an analysis, and run the analysis — all from outside the MindBridge app. Then, just hop into MindBridge to view the analysis results.
Learn about the general use of the MindBridge API.
Configuration details
You must be an App Admin to access the API page.
How do I get access to the API?
Contact your App Admin to request access to the MindBridge API.
How does an API work?
An API allows an application to communicate with the MindBridge app through a set of clearly defined commands, enabling secure access to enterprise assets and processes using a REST interface.
As displayed in the image below, using an API is similar to placing an order at a restaurant. Think of API commands as ordering off a restaurant menu — the menu defines a list of available "dishes" (i.e., programs or functions), and when you place an order, the kitchen (i.e., the server or database) prepares the food (i.e., the request) in the back, then sends it out to you when it is ready.
In brief, APIs define a list of commands. When an ERP uses one of those commands, MindBridge sends back what was requested.
What is a REST architecture?
MindBridge uses a RESTful API architecture, which allows computer systems to exchange information securely over the internet utilizing HTTPS protocol. Requests made via a RESTful API are stateless, and each request contains all of the data necessary to complete the request successfully.
What are the benefits of using an API?
APIs allow for:
- Scalable data ingestion and exporting results using automation
- A unified data analysis platform, regardless of industry or organization needs
- Secure and controlled access to MindBridge’s data which creates new opportunities for analysis and insights at scale
- The automation of complex, repeatable tasks
What is a MindBridge API token?
A MindBridge API token (an "API token") is a string of characters that acts as a key to the API, and is implemented as an authentication bearer token. It is utilized by adding the token to the header of each HTTPS request.
This token type is a cryptographically secure authentication token that includes the configured permissions allowing API clients to access MindBridge API resources or "endpoints".
How do I use the API token?
In order to utilize a token generated within the MindBridge platform, you must add the following to the header of each HTTPS request:
Authorization: Bearer {token} Accept: application/json
How long do API tokens last?
The token lifecycle is configurable by the App Admin for any period of time, up to a maximum of 2 years.
What happens if my API token is compromised?
Tokens must be stored it in a secure location, and should never be shared. The security of your token is paramount.
If a token is compromised, the App Admin should disable and re-issue the token immediately.
What is an endpoint?
Endpoints are exposed functions of an application API with functionality provided by HTTPS methods.
What is an HTTPS method?
An HTTPS method represents functionality supported by the HTTPS protocol, such as GET, POST, PUT, PATCH, and DELETE.
These methods essentially allow you to read, write, or delete libraries, organizations, engagements, analyses, users, and much more.
How are API tokens generated?
An App Admin creates API tokens in the Admin section of the app, where they can apply lifecycle and permissions to each token.
Learn how to create a MindBridge API token.
Who can access and use the API?
Anyone who has a valid token is able to use the API.
App Admins are responsible for managing API tokens, and can grant API access to any users within the engagement.
How do I use the API?
To use the API:
- An API token must be generated by an App Admin within MindBridge.
- Once you have access to the API token, use the HTTPS protocol to make a request to a documented endpoint in the MindBridge API.
Requests can be made from a variety of sources, including most programming languages or Postman.
What is the format for communicating with the API?
The API utilizes JSON for all request and responses, with the exception of data files, which can be imported in any format supported within the application.
What file formats are accepted through the API?
Inbound
All file formats currently supported by the file manager will be accepted, such as .xlsx, .csv, .xlsb, and more.
Outbound
JSON results only.
What files can I push or pull through the API?
Inbound
All files currently supported by the MindBridge platform can be pushed through the API.
Files can be assigned to any of the sources within an analysis, such as the "general ledger detail" slot.
Outbound
The API will support paginated, queryable analysis results, indexed by either transactions, or entries. The data available is equivalent to the data table in the MindBridge platform.
Where can I find more detailed documentation?
The following articles provide additional details and guidance regarding the MindBridge API.
For technical documentation, open the Actions menu on right side of the API tab, then select View API reference. You will be brought to the API reference document.
To see an ongoing list of changes made to the API, open the Actions menu on right side of the API tab, then select View API changelog. You will be brought to the API changelog.
For more information or contact us at info@mindbridge.ai.
As a user of the API, where can I start?
- Read the MindBridge API documentation
- Generate or get access to an API token
- Try out desired API endpoints and actions
Anything else on your mind? Chat with us or submit a request for further assistance.