Use API Products as a Customer

In the Developer Portal, a product represents an API offered by a Provider. As a Customer, you can browse the marketplace and select an API that meets your needs. The API provides technical and conceptual information, including its endpoints, request and response formats, and additional documentation or instructions.

Once you have selected an API, you can view details and documentation and then request access to it. This is usually done by submitting an activation request, where you ask the Provider to grant you access to their API products. The activation request may require you to provide additional information or agree to certain conditions, depending on the Provider's requirements.

Overview API

Adding and Deleting Plans via a Subscription in the Context of Apps

Once you have found an API for your use case, you can add it to an App in various ways.

The first way to add a plan to an App is easy if you follow these steps:

1. go to the marketplace.
2. find the right products for your use case (always in the context of a Provider).
3. go to the detailed view of the product.
4. click on the "Add to App" button in the right-hand corner.
5. select a suitable plan for you.
6. add it to an existing App or create a new App.

When your app is ready, submit a activation request to access the selected plans. Once a plan is approved, you will have an active subscription.

The second way to add a plan to an App is easy if you follow these steps:

1. go to the sidebar and select "Apps".
2. create a new App.
3. select a Provider you want to purchase from.
4. add your preferred plan to the App.

Documentation Files of an API

The Developer Portal offers various documentation options for an API. First of all, the Developer Portal focuses on technical documentation. On the detail page of the product you will find a technical description (Markdown) as well as an open API file, which is displayed in the Swagger UI.

Sandbox Systems Connections*

*coming soon.