Getting Started

Welcome to the developer portal for consuming APIs through Azure API Management (APIM). This guide will assist you in registering, authenticating, and using the available APIs. You will learn the necessary steps to access APIs, request credentials, authenticate, and move from testing to production.

1. Overview

APIs are vital components of digital solutions, enabling seamless integration between different applications and services. Azure API Management provides a platform to securely expose these APIs to internal and external consumers. This document will guide you through the process of onboarding and using the APIs, customized for internal and external developers.

2. Accessing the Developer Portal

External users, including partners and third-party developers, can access the APIs via the public-facing developer portal using the External API Portal URL

3. Creating an Account

1.      Sign up for an account by navigating to the Developer Portal and clicking "Sign up".

2.      Fill out the required information

3.      Review and accept the API Terms of Use.

4.      Click the "Sign Up" button.

5.      You'll receive an activation email to verify your email address.

6.      Log in to the portal and start browsing the API catalog.

4. Logging In

· Visit the Developer Portal and click "Sign In."

· Use your registered email address and password to access the portal

5. API Discovery

APIs are grouped by Products

Browse the available APIs. Each API has a dedicated documentation page featuring:

· Navigation menu

· List of endpoints

· Detailed documentation for each endpoint

· Example responses and error codes

6. Requesting API Access

Click Subscribe to request access for the APIs you wish to use.

After submitting your request, you will receive an API subscription key upon approval.

You can use the subscription key in your client to authenticate to the API

7. Testing APIs

The developer portal allows you to test APIs directly:

Navigate to the desired API’s documentation.

Use the Try It Out feature to test requests and responses.

8. External Support Channels

For any issues or questions email: api.support@MPC.com

9. Authentication

Both internal and external consumers must authenticate to use the APIs. Azure API

management offers multiple authentication mechanisms.

10. API Key Authentication

Every API request must include the API subscription key in the header.

         Example API Key Header: 

                       Ocp-Apim-Subscription-Key: {your-subscription-key

11. OAuth 2.0 Authentication

For more secure APIs, OAuth 2.0 may be required. To use OAuth:

· Obtain an access token from the authorization server.

· Include the token in the Authorization header when making API requests.

12. Moving to Production

Once your testing is complete and you are ready to move to production:

· Ensure all API requests work as expected in the test environment.

· Coordinate with the API support team to receive production credentials and update your API endpoints.

3. Monitor usage and performance regularly.

13. Performance Considerations

External developers should be aware of rate limits and throttling policies. Depending on your subscription tier, different limits apply.

Standard rate limit: 100 requests per minute.