MCT API Integration ¶
To integrate with the MCT API, it is beneficial to have a basic understanding of RESTful API principles.
RESTful API Overview ¶
The MCT API follows the RESTful specification, which was introduced and defined in 2000 by Roy Fielding, one of the principal authors of the HTTP specification versions 1.0 and 1.1. For more detailed information on RESTful API concepts and best practices, please visit restfulapi.net.
Designing a RESTful API ¶
If you are interested in designing your own RESTful API, you can refer to the following tutorial for guidance and examples: Rest API Design Tutorial with Example.
Accessing the REST API with cURL ¶
To interact with the MCT API, you can use cURL, a command-line tool for making HTTP requests. The following is an example command using cURL to access the API:
curl -i -H "Accept: application/xml" -X GET -d "para1=val1¶2=val2" http://ip:port/platform/healthcheck
Please replace ip:port with the appropriate IP address and port of the MCT API server. Modify the para1=val1¶2=val2 section to pass any required parameters in the request.
Links ¶
More API documentation could be found HERE