Tutorial

This page is a quick tutorial on how to use this site as well as how to plug the information contained in this site in to Postman. Postman is a third party tool for testing API's and is free to use. You can download from their website here.

Prerequisites

  • You will receive an email invitation to access our API Gateway.

  • You will receive a separate email containing your API Key.

Section 1: Accessing API's via API Gateway

Step 1: Create Your Account

  1. Open the invitation email sent to you.

  2. Create your account using the provided link.

  3. Once the account is created successfully, log in to the API Gateway portal.

Step 2: View Available API's

  1. After logging in, navigate to the API's section.

  2. You will see a list of API's you have access to.

  3. Click on the API you want to use.

  4. Review

    • Available endpoints

    • HTTP methods (GET, POST, etc.)

    • Required request payloads and parameters

Step 3: Use the "Try this Operation" Feature

  1. Select an endpoint inside the API

  2. Click the Try This Operation button

  3. Add the required payload (if applicable)

  4. Execute the request to validate the response.

    • Authentication is handled using an API Key, which is provided separately via email.

Step 4: API Key Usage

  • The API key must be included in request headers.

  • Example header:

Ocp-Apim-Subscription-Key: <YOUR_API_KEY>

Section 2: Import API Collection into Postman

Alternatively, you can download the API collection directly from the API Gateway.

1. Download the API collection from the API Gateway.

2. Download the collection file.

3. Open Postman -> Import -> Upload the collection.

4. After importing:

  • Add the API key in the headers or a Postman environment

  • Use the same API key/token shared with you via email.

5. Send requests directly using the imported collection.