To access the IMS Developer Portal on any instance of IMS:
Navigate to the Developer Portal address in your web browser:
[URL]/developer - (e.g.: https://ims-latest.apps.cenosco.local/developer)
The IMS Developer Portal will be displayed in your browser.
All of the available APIs will be listed, grouped by functionality. To view the specific APIs available in each section:
Click on the desired row to expand the list of APIs under that category.
Note
The specific APIs available to you may vary, depending on the site-specific IMS Implementation.
API Types
APIs in the Developer Portal are colour-coded and labeled by functionality:
API Type | Functionality |
|---|---|
| GET APIs are used to retrieve information from the database, without changing any of the underlying data. |
| POST APIs are used to add new information to the database. |
| PATCH APIs are used to update existing information in the database. |
| DELETE APIs are used to delete records or other information in the database. |
Note
Developers should be particularly careful about using POST, PATCH and DELETE APIs due to the fact that they can change existing records in the IMS Database.
API Documentation
To access the instructions for using each of the APIs:
Click on the line corresponding to the desired API.
When the line corresponding to the desired API has been clicked, the available API documentation will show. This includes:
Description.
Usage examples.
Required parameters.
Potential responses to requests, together with an example of the type of data that might be returned.
Read on to learn about Cenosco’s Authentication Service.