Difference between revisions of "API Documentation"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
PTS 5 | PTS 5 includes a self-documenting application programming interface (API). | ||
The PTS 5 API is an HTTP REST API and implements the open source Swagger UI API self-documenting tool. The documentation can be accessed by simply appending /swagger to the end of your PTS URL, e.g.: <strong><nowiki>http://YourPTSServer/PTSWeb/swagger</nowiki></strong> | The PTS 5 API is an HTTP REST API and implements the open source Swagger UI API self-documenting tool. The documentation can be accessed by simply appending /swagger to the end of your PTS URL, e.g.: <strong><nowiki>http://YourPTSServer/PTSWeb/swagger</nowiki></strong>. This will not only reflect the exact version of PTS you have installed but will allow you to test the API with your own data. | ||
The Swagger implementation for our live PTS 5 demo, which is constantly updated to the latest version, can be found here: http://prescriptiontracking.co.uk/swagger | The Swagger implementation for our live PTS 5 demo, which is constantly updated to the latest version, can be found here: http://prescriptiontracking.co.uk/swagger | ||
Revision as of 10:44, 18 July 2022
PTS 5 includes a self-documenting application programming interface (API).
The PTS 5 API is an HTTP REST API and implements the open source Swagger UI API self-documenting tool. The documentation can be accessed by simply appending /swagger to the end of your PTS URL, e.g.: http://YourPTSServer/PTSWeb/swagger. This will not only reflect the exact version of PTS you have installed but will allow you to test the API with your own data.
The Swagger implementation for our live PTS 5 demo, which is constantly updated to the latest version, can be found here: http://prescriptiontracking.co.uk/swagger