# Types of API Portal

Anyone can become a provider and generate your API portals. For more information, please refer to “Become a Provider and Generate API Portals”.

There are 3 types of API Portals on OpenAPIHub - Public, Members-only, Unlisted. Update the permission of your API Portal to control where your API Portal can appear and who can view it.

Different provider plans will support different types of API Portal, please refer to OpenAPIHub API Provider Plans (opens new window) for details

# Public

Anyone on OpenAPIHub can see Public API Portals. They will show up in search results and related provider lists. *Providers with Starter plan will not be listed on the provider list.

# Members-only

Logged-in users on OpenAPIHub can see Members-only API Portals. They will show up in search results and related provider lists. For guest user, they can only see the basic information of the API Portal (e.g. portal name, short description, profile picture) but they need to log in to view the API Portal detailed contents. *Providers with Starter plan will not be listed on the provider list.

# Unlisted

Unlisted API Portals can be seen by anyone with the API Portal’s link and logged in. They will NOT show up in OpenAPIHub search results and related provider lists. For guest user with the API Portal’s link, they will be asked to log in to enter the API Portal.

Feature Public Members-only Unlisted
Shows up in search result and related provider lists ✔️ (1) ✔️ (1)
Be viewed by guest user ✔️
Be viewed by logged in user ✔️ ✔️ ✔️ (2)
Only accessible to member with API Portal's link ✔️

Remarks:

  • (1): Providers with Starter plan will not be listed on the provider list.
  • (2): Only if the user has API Portal's link