OpenAPIHub User Guide

# Developer Mission #3 - Make an API Call and Check the API Usage

# Introduction

In this mission, we will guide you on how to make an API call in the interactive API explorer in OpenAPIHub and check the API usage. In order to do so, you are required to have at least one active API subscription. If you are not sure how to get it, please refer to Developer Mission #1 - Subscribe to a Free API on OpenAPIHub

You need to register as an API developer on OpenAPIHub before using the Developer Admin Portal. Please refer to Register as a Developer for details.

# Key Steps

This mission consists of two parts. In the first part, we will show you how to make an API Call from the interactive API Explorer. In the second part, we will check the API Usage in the Developer Admin portal. As an example, we will take the Echo API (opens new window) by OpenAPIHub Academy (opens new window) to walk you through the process.

Part 1 - Make an API Call

  1. Go to OpenAPIHub Marketplace to find a subscribed API (opens new window) (For example - Echo API (opens new window))

  2. Go to the Endpoints (opens new window) tab of the API

  3. Use Try It Out with the required parameters

Part 2 - Check API Usage

  1. Go to Developer Admin Portal (opens new window)
  2. Select Subscribed APIs (opens new window) from the sidebar
  3. Select a subscribed API (For example - Echo API) and Check the API Usage

# Step-by-step Guide

# Part 1 - Make an API Call

  1. Go to OpenAPIHub Marketplace to find a subscribed API (opens new window) (For example - Echo API (opens new window))

  1. Go to the Endpoints (opens new window) tab of the API

  1. Make an API call using Try It Out with the required parameters To make an API call successfully, we have to provide the correct parameters. In our example, Echo API takes a string ("msg") together with our security API key ("X-OpenAPIHub-Key").

When all the parameters are set, click "Try It out" to make the API call. The API response below should be returned.

# Part 2 - Check API Usage

TIP

Please note that after making the API Call, the API Usage may take time to be reflected in the Developer Admin Portal. Normally, it may take 5-10 mins after the API requests were made.

  1. Go to Developer Admin Portal (opens new window)

  1. Select Subscribed APIs (opens new window) from the sidebar

  1. Select an API (for example - Echo API) from the subscribed API list and Check the API Usage

Congratulations! You have successfully made an API Call and checked the API Usage. Please make use of this function to try out different API endpoints and keep track of your subscribed API Usage. Now, you have completed Developer Mission #3, your mission progress can be found in the Developer Admin Portal (opens new window).

Please go to Developer Mission #4 and learn more essential skills in OpenAPIHub or feel free to explore the Marketplace (opens new window).

← Developer Mission #4 - Complete Your Developer Profile →