Create Apps as a Customer
Basic Concept of Apps
The main concept of Apps is to group multiple API products in the context of a Provider. By registering API products to an App, the customer can use the services offered by these API products using the stored authentication method. By using Apps, customers can bundle their access to multiple API products, manage the authentication methods and establish a contractual relationship with the Provider.
Note, however, that you can only add API products from a single Provider to an App.
Overview Apps
Description
| Term | Description |
|---|---|
| App Contract Status | Describes the contractual relationship between Provider and Customer. |
| App Access Status | Describes whether the app can generally be accessed. |
| App-Approval & Subscription-Approval | Describes a workflow which is necessary for the approval of App & subscription. |
| Access | Required means of authentication to access an API. . |
| API & Authentication Means | An API has an authentication method. This defines which authentication means can be used to access the API. |
| Plans & Subscriptions | A subscription describes the connection between an App and a plan of an API. The plan describes the extent to which the product can be used. |
Create App
**Preconditions
- Developer Portal access
- Customer
Create an App via Frontend:
You can create Apps in different ways via the user interface if you follow these steps:
- create an App via the marketplace.
- when you have found your API, add it to an existing App. 1 - n plans are added to an App in the context of an API.
- create an App on the detail page (the App detail view).
It is also possible to add an App via the Developer Portal API.
Create an Activation Request
**What is an activation request and what is the purpose of this concept?
We have implemented the activation request to give you access to our API products as quickly as possible. as quickly as possible. However, we understand that sometimes this is not always easy due to various circumstances. For example regulatory requirements, Provider-specific requirements or pre-contractual agreements can delay the process.
The activation request is similar to the checkout process in an e-commerce store. It is designed to give you smooth and efficient access to our services. Our aim is to make this process as clear and understandable as possible.
Prerequisites
- Developer Portal access
- Customer
Once you have filled in all the relevant fields for your Apps, you can submit the activation request.
Processing States of an App (App-Approval & Subscription-Approval)
App-Approval & Subscription-Approval = App-Contract-Status
| Name | Trigger | Description |
|---|---|---|
| create() | Customer Admin | Customer creates a new App. |
| goLive() | Customer Admin | Customer makes an activation request to the App. |
| process() | Provider Admin | Min. 1 approval of App or subscription must have been set to the processing state by the Provider. |
| approve() | Provider Admin | All App and subscription approvals have been approved by the Provider |
| reject() | Provider Admin | At least 1 approval (App or subscription) has been rejected by the Provider. |
| terminates() | Customer or Provider Admin | Min. 1 subscription approval or the App approval has been terminated by the Customer or Provider |
| terminate() | System | App approval and all subscription approvals have been terminated or expired. |