Azure APIM (API Management Tool)
Summary:
We've transitioned from Swagger and will now utilize Azure APIM for viewing and testing API endpoints. Azure API Management (APIM) is a robust platform provided by Microsoft Azure for managing and securing APIs. It serves as a gateway that enables organizations to publish, monitor, analyze, and secure APIs in a scalable and efficient manner.
Utilizing Azure:
You'll receive a URL for Azure APIM from our Integration Support team along with an Auth Key. This will grant you access to test the API Endpoint, as well as access to the API documentation.
Steps:
Log in to Azure API Per URL provided:
To view The Bridge documentation you will click on “User Guide”:
This link will direct users to a publicly accessible Confluence page detailing "The Bridge". There, users can access information on:
Information on The Bridge
Best practices
Integration partners (Soon to come)
FAQ (Soon to come)
To test API endpoints the user will click on the “Explore APIs” button
When users click the "Explore API" button, they'll be redirected to the "Explore API" page. Here, they can access technical details about the API endpoints and experiment with trying out the API endpoints themselves.
If user wants to try the end point they will click on the green “Try It” button.
A panel will open on the right side of the screen where the user can enter a set of Parameters and run the API by clicking the Send button.
