Skip to main content

For Providers

Organization​

The definition of a Provider is simple. It is an organization that provides API products and manages access to services for all its Customers. If you want to act as a provider of API products, please contact the operator of the Developer Portal (Support) to set up and activate your organization.

API product​

The following guide will help you gain deeper knowledge of the “API product” entity in the Developer Portal. An API product defines an API in the Developer Portal and consists of various components that can be used to describe it.

To add API products in the Developer Portal, please follow these steps:

  1. add a new API
  2. add a detailed description of the API
  3. add documentation files to the API
  4. set the visibility (public or private) of the API
  5. invite Customers to your private API

Documents​

Providers and customers of API products can upload and exchange documents in the Developer Portal. The documents can be stored in the predefined structures.

Structure:

  • API Explorer (openAPI)
  • FAQ
  • Readme
  • Other

Apps​

The purpose of registering API products in an App is to use these services using authentication at App level. By grouping the authentication, it is possible to directly access multiple services in the context of a Provider. The App can also contain several access data or API keys.

As a Provider, you have the option of managing the status of an activation request made by a Customer.