Apps als Kunde erstellen
Grundlegendes Konzept von Apps
Das Hauptkonzept von Apps besteht darin, mehrere API-Produkte im Kontext eines Anbieters zu gruppieren. Indem API-Produkte zu einer App registriert werden, kann der Kunde die von diesen API-Produkten angebotenen Dienste mithilfe der hinterlegten Authentifizierungsmittel nutzen. Durch die Nutzung von Apps können Kunden ihren Zugriff auf mehrere API-Produkte bündeln, die Authentifizierungsmittel verwalten und eine vertragliche Beziehung zum Anbieter etablieren.
Beachte jedoch, dass du nur API-Produkte von einem einzigen Anbieter zu einer App hinzufügen kannst.
Überblick Apps
Beschreibung
| Begriff | Beschreibung |
|---|---|
| App-Contract-Status | Beschreibt die vertragliche Beziehung zwischen Anbieter und Kunde. |
| App-Access-Status | Beschreibt, ob generell auf die App zugegriffen werden kann. |
| App-Approval & Abo-Approval | Beschreibt einen Workflow, welcher für die Genehmigung von App & Abo notwendig ist. |
| Access | Benötigtes Authentifizierungsmittel, um auf eine API über den Authenticator zugreifen zu können. |
| API & Authentifizierungsmittel | Eine API besitzt ein Authentifizierungsmethode. Dieses definiert mit welcher Authentifizierungsmethode auf die API zugegriffen werden kann. |
| Pläne & Abonnements | Ein Abonnement beschreibt die Verbindung zwischen einer App und einem Plan einer API. Der Plan beschreibt dabei in welchem Umfang die API genutzt werden kann. |
App anlegen
Vorbedingungen
- Developer Portal-Zugang
- Kunde
Erstelle eine App via Frontend:
Du kannst Apps auf verschiedene Arten über die Benutzeroberfläche erstellen, wenn du diesen Schritten folgst:
- Erstelle eine App über den Marktplatz.
- Wenn du deine API gefunden hast, füge sie einer vorhandenen App hinzu. Es werden 1 - n Pläne zu einer App im Kontext einer API hinzugefügt.
- Erstelle eine App auf der Detailseite (der App-Detail-View).
Darüber hinaus besteht auch die Möglichkeit, eine App über die Developer Portal-API hinzuzufügen.
Erstelle eine Aktivierungsanfrage
Was ist eine Aktivierungsanfrage und welchem Zweck dient dieses Konzept?
Wir haben die Aktivierungsanfrage implementiert, um dir so schnell wie möglich den Zugriff auf unsere API-Produkte zu ermöglichen. Wir verstehen jedoch, dass dies manchmal aufgrund verschiedener Umstände nicht immer einfach ist. Zum Beispiel können regulatorische Anforderungen, anbieterspezifische Anforderungen oder vorvertragliche Vereinbarungen den Prozess verzögern.
Die Aktivierungsanfrage ähnelt dem Checkout-Prozess in einem E-Commerce-Shop. Sie ist darauf ausgerichtet, dir einen reibungslosen und effizienten Zugang zu unseren Diensten zu gewährleisten. Unser Ziel ist es, diesen Prozess so klar und verständlich wie möglich zu gestalten.
Vorbedingungen
- Developer Portal-Zugang
- Kunde
Sobald du alle relevanten Felder deiner Apps befüllt hast, kannst du die Aktivierungsanfrage stellen.
Verarbeitungszustände einer App (App-Approval & Abo-Approval)
App-Approval & Abo-Approval = App-Contract-Status
| Name | Auslöser | Beschreibung |
|---|---|---|
| create() | Kunde Admin | Kunde erstellt eine neue App. |
| goLive() | Kunde Admin | Kunde stellt eine Aktivierungsanfrage an der App. |
| process() | Anbieter Admin | Min. 1 Approval von App oder Abonnement muss vom Anbieter in den Bearbeitungszustand gesetzt worden sein. |
| approve() | Anbieter Admin | Alle App- und Abonnement-Approval sind vom Anbieter genehmigt worden, somit setzt das System den Status der App auf approved. |
| reject() | Anbieter Admin | Min. 1 Approval (App oder Abonnement) ist vom Anbieter abgelehnt worden. |
| terminates() | Kunde o. Anbieter Admin | Min. 1 Abonnement-Approval oder das App-Approval wurde vom Kunden oder Anbieter gekündigt |
| terminate() | System | Das App-Approval und alle Abonnement-Approval wurden beendet bzw. sind abgelaufen. |