Table of contents
- API Usage Guide
- API Command Reference
- Appendix A - Activity Codes
- Appendix B - Setting Names
- Appendix C - Error Handling
- Code Samples
- Release Notes
MIDAS API: Making API calls
API calls via HTTPTo make an API call, your application will need to perform an HTTP POST transaction (HTTP GET requests can also be enabled - see API Settings) to http(s)://your_midas_url/api.pl.
Each request must include as a minimum:
- Your unique MIDAS API key
- An API command
- All associated required parameters for the particular API command issued (if applicable).
The API key itself may be passed in a GET/POST parameter, or via an "X-API-KEY" HTTP header (recommended).
Please refer to the API Command Reference for details of available API commands and associated parameters.
API calls from the Command Line(Available in API v2.19+ for self-hosted editions of MIDAS only)
In addition to making API calls via HTTP, the MIDAS API also permits calls to be made directly from the command line.
API calls made in this way have the added benefit of being significantly faster (assuming the call is made from the command line on the same server as the MIDAS system), as they do not require an HTTP transaction to be conducted.
To make API calls from the command line, simply call "api.pl" (located within your server's MIDAS directory) and pass API parameters & values via command line switches.
For example, to retrieve the currently installed version of MIDAS from the Windows command line (cmd):
...or from Windows PowerShell:
API calls fromPostman is a third party API development tool, helping developers build, test, collaborate and integrate APIs.
If you use Postman, we have a MIDAS API collection available for import. For more information, please see our KB article: Using the MIDAS API with Postman.