Für Anbieter
Organisation
Die Definition eines Anbieters ist einfach. Es handelt sich um eine Organisation, die API-Produkte bereitstellt und den Zugang zu Diensten für alle ihre Kunden verwaltet. Wenn du als Anbieter von API-Produkten auftreten möchtest, setze dich bitte mit dem Betreiber des Developer Portals (Support) in Verbindung, um deine Organisation einrichten und freischalten zu lassen.
API-Produkte
Dieser Leitfaden hilft dir, ein besseres Verständnis der "API-Produkt"-Entität im Developer Portal zu entwickeln. Ein API-Produkt definiert eine API und besteht aus verschiedenen Attributen, mit denen es beschrieben werden kann.
Um eine neue API im Developer Portal hinzuzufügen, befolge bitte diese Schritte:
- Füge eine neue API hinzu.
- Füge eien detailierte Beschreibung der API hinzu.
- Füge der API Dokumentationsdateien hinzu.
- Setze die Sichtbarkeit (öffentlich oder privat) der API.
- Lade Kunden zu deiner privaten API ein.
Dokumente
Der Anbieter und Kunde von API-Produkten können Dokumente im Developer Portal hochladen und somit austauschen. Die Dokumente können in den vorgegebenen Strukturen abgelegt werden.
Struktur:
- API-Explorer (openAPI)
- FAQ
- Readme
- Sonstiges
Apps
Der Zweck der Registrierung von API-Produkten in einer App besteht darin, diese Dienste mithilfe der Authentifizierung auf App-Ebene zu nutzen. Durch die Gruppierung der Authentifizierung ist es möglich, direkt auf mehrere Dienste im Kontext eines Anbieters zuzugreifen. Die App kann auch mehrere Zugangsdaten oder API-Schlüssel beinhalten.
Als Anbieter hast du die Möglichkeit, den Status einer Aktivierungsanfrage, die von einem Kunden durchgeführt wurde, zu verwalten.