Zum Hauptinhalt springen

API-Produkte als Provider hinzufügen

Als Anbieter ist ein API-Produkt ein grundlegendes Konzept im Developer Portal, da es eine von Dir angebotene API repräsentiert. Bei der Erstellung von API-Produkten kannst du den Namen und eine kurze Beschreibung dessen, was es tut, hinterlegen.

Neben diesen grundlegenden Eigenschaften kann eine API im Developer Portal auch mehrere andere Komponenten haben:

  • API-Dokumentation: Hier kannst du detaillierte technische Dokumentation für deine API bereitstellen, einschließlich ihrer Verwendung, eventuell erforderlicher Parameter und möglicher Fehlercodes (zur Zeit unterstützen wir das OpenAPI Format).
  • Sicherheit: Hier kannst du die Authentifizierungsmechanismen hinterlegen, die Kunden verwenden müssen, um auf deine API zuzugreifen.
  • Pläne & Abonnements: Ein Plan kann die Services/Leistungen einer API gruppieren bzw. zusammenfassen und einem Kunden angeboten werden.
  • Downloads: Hier kannst du mehr Informationen über deine API den Kunden zur Verfügung stellen.
info

Durch die Definition all dieser Komponenten kannst du ein gut dokumentiertes und für Verbraucher leicht zu nutzendes Produkt erstellen.

Überblick API​

Neue API hinzufügen​

So fügst du eine neue API im Developer Portal hinzu:

  1. Melde dich am Developer Portal an.
  2. Klicke auf die Schaltfläche "API hinzufügen", die sich normalerweise auf der API-Übersichtseite befindet.
  3. Fülle die erforderlichen Felder für die API aus.
  4. Füge zusätzliche Dokumentationsdateien, wie Anleitung zur Verwendung oder Referenzdokumente, im Bereich "Dokumentation" hinzu. Markiere die ausgewählte Readme-Datei oder OpenAPI-Datei mit Tags.
  5. Wähle die visuelle Identität der API.
  6. Lege die Sichtbarkeit der API im Bereich "Sichtbarkeit" auf öffentlich oder privat fest. Wenn du "privat" auswählst, kannst du bestimmte Kunden einladen, auf die API zuzugreifen.
  7. Speichere die API-Details und lade Kunden ein, denen du Zugriff auf die API gewähren möchtest.
  8. Lege Pläne an, um die Services/Leistungen deiner API zu definieren und zu gruppieren.
  9. Veröffentliche die API.