OpenAPIHub User Guide

# Introduction of Provider Admin Portal

You need to generate your API Portal on OpenAPIHub before using the Provider Admin Portal. Please refer to Become a Provider and Generate API Portals to generate your API Portal.

  1. To enter the Provider Admin Portal, you can either go to View all portals (opens new window) OR go to Developer Admin Portal and click the dropdown list, then click Provider Admin on the menu.

  1. After entering the Provider Admin Portal, there are 3 main things you can perform:
  • Click on the Portal Card : Enter the Specific API Portal Management Dashboard and manage its details, you can select different pages from the side bar.
  • Click on the "link" button : Enter the Specific API Portal on OpenAPIHub (i.e Other OpenAPIHub user’s view of your API Portal)
  • Click “Generate New Portal”: Fill in a form to general a new API Portal. For more information , please refer to Become a Provider and Generate API Portals.

# Get Started

  • List the missions that can help you learn the basics of the Provider Admin Portal.

# API Performance

  • Analytics

    • View the performance analytics of APIs you added on OpenAPIHub, e.g. Number of API Calls by Other Developers, Error Rate and Latency of API.

    • The data can be sorted by APIs, date and be shown in a graph for easier reading.

  • Logs

    • List the detailed logs of the API call record.

    • It can be sorted by API, Developer, Response Status and Date.

# My APIs

  • My APIs

    • View and edit all APIs you added on OpenAPIHub for details.

    • APIs can be sorted by Name, customized Groups, Category and Permission.

  • Create API

    • Add new API.

# Subscriptions

  • User Subscriptions

    • List all purchase record of all APIs.

    • It can be exported in excel and sorted by API, Purchase ID, Developer and Payment Status.

# Portal Theme

  • Display Information

    • Edit basic information of your portal, e.g. Display Name, Public Contact and Provider Guides.

  • Design & Branding

    • Customize your API Portal with text, images & theme colours.

  • Landing Page Setting

    • Customize your portal landing page with text and images.

# Portal Setting

  • Access Control

    • Edit Portal permission to decide who can view your API Portal.

  • Monetization Setup

    • Link your portal to your payment collection accounts to unlock Monetization feature.

  • Verification

    • Get verification badge on OpenAPIHub as a qualified API Portal.

  • Admin API Credential

    • Automate your API Portal administration workflow via CI/CD pipeline.

# Usage and Billing

  • Usage and Billing

    • Check your API quota and monetization usage.

# Provider Profile

  • Provider Information

    • Edit primary contact person for receiving emails.

  • Company Information

    • Edit company information for internal reference.

← Update API Provider Profile →