Zum Hauptinhalt springen

API-Produkte als Kunde nutzen

Im Developer Portal repräsentiert ein API-Produkt eine von einem Anbieter angebotene API. Als Kunde kannst du den Marktplatz durchsuchen und eine API auswählen, die deinen Bedürfnissen entspricht. Die API liefert technische und konzeptionelle Informationen, einschließlich ihrer Endpunkte, Anfrage- und Antwortformate sowie zusätzlicher Dokumentation oder Anleitungen.

Nachdem du eine API ausgewählt hast, kannst du Details und Dokumentation einsehen und dann den Zugriff darauf beantragen. Dies geschieht in der Regel durch das Einreichen einer Aktivierungsanfrage, bei der du den Anbieter darum bittest, dir Zugriff auf seine API-Produkte zu gewähren. Die Aktivierungsanfrage kann erfordern, dass du zusätzliche Informationen bereitstellst oder bestimmten Bedingungen zustimmst, abhängig von den Anforderungen des Anbieters.

Überblick API-Produkt

Hinzufügen und Löschen von Plänen über ein Abonnement im Kontext von Apps

Wenn du eine API für deinen Anwendungsfall gefunden hast, kannst du sie auf verschiedene Arten zu einer App hinzufügen.

** Der erste Weg, einen Plan zu einer App hinzuzufügen, ist einfach, wenn du diesen Schritten folgst:**

  1. Gehe zum Marktplatz.
  2. Finde die richtigen API-Produkte für deinen Anwendungsfall (immer im Kontext eines Anbieters).
  3. Gehe zur Detailansicht der API.
  4. Klicke auf den Button "Zu App hinzufügen" in der rechten Ecke.
  5. Wähle einen für dich passenden Plan aus.
  6. Füge die API einer bestehenden App hinzu oder erstelle eine neue App.

Wenn deine App bereit ist, stelle eine Aktivierungsanfrage, um auf die ausgewählten Pläne zugreifen zu können. Sobald ein Plan genehmigt wurde, hast du ein aktives Abonnement.

** Der zweite Weg, einen Plan zu einer App hinzuzufügen, ist auch einfach, wenn du diesen Schritten folgst**:

  1. Gehe zur Seitenleiste und wähle "Apps" aus.
  2. Erstelle eine neue App.
  3. Wähle einen Anbieter aus, von dem du API-Produkte und Pläne beziehen möchtest.
  4. Füge deinen bevorzugten Plan der App hinzu.

Dokumente einer API

Das Developer Portal bietet verschiedene Möglichkeiten der Dokumentation für eine API. Zunächst einmal konzentriert sich das Developer Portal auf eine Dokumentation. Auf der Detailseite der API findest du eine technische Beschreibung (Markdown) sowie eine OpenAPI-Datei, die im Swagger UI dargestellt wird.

Sandbox Systems Connections*

*coming soon.