Seminar Gravitee Developer Portal, API Products und Consumer Management

Das Seminar behandelt den Aufbau eines nutzbaren API-Katalogs und den vollständigen Consumer-Lifecycle. Veröffentlichung, Dokumentation, Anwendungen, Subscriptions, Zugriffsfreigaben und API Products werden aus Sicht von Plattformbetreibern und API-Anbietern praktisch umgesetzt.

Inhaltsübersicht

• Seminarziele
• Inhalte
• Praxisübungen
• Zielgruppe
• Voraussetzungen
• Arbeitsweise

Seminarziele

Im Seminar werden folgende Kompetenzen aufgebaut:

• Developer Portal als internen oder externen API-Katalog strukturieren
• APIs, Dokumentation, Kategorien und Zugriffsrechte zielgruppengerecht veröffentlichen
• Anwendungen, Subscriptions, Freigaben und Credentials sicher verwalten
• Mehrere V4-HTTP-APIs als API Product mit einheitlichem Plan bündeln
• Onboarding, Self-Service, Branding und Consumer-Kommunikation verbessern
• Nutzungsdaten und Supportinformationen aus Consumer- und Provider-Sicht auswerten

Inhalte

Portalarchitektur und Zielgruppen

• Management Console gegenüber Developer Portal
• Interne Entwickler, Partner, Kunden und technische Servicekonten
• Katalogstruktur, Kategorien, Sichtbarkeit und Suchbarkeit
• Einordnung verfügbarer Portalvarianten und Migrationsaspekte

API-Veröffentlichung und Dokumentation

• Lifecycle State, Portalveröffentlichung und Zugriffssteuerung
• OpenAPI-, AsyncAPI-, Markdown- und strukturierte Dokumentationsseiten
• Beispiele, Nutzungsanleitungen, Fehlerverträge und Änderungsinformationen
• Interaktive Tests und sichere Testzugänge

Anwendungen und Credentials

• Anwendungstypen, Eigentümer und Consumer-Teams
• API Keys, Client IDs, Zertifikate und Credential-Lifecycle
• Dynamic Client Registration und externe Authorization Server
• Rotation, Widerruf und Nachvollziehbarkeit

Subscriptions und Freigaben

• Subscription-Anfrage, manuelle oder automatische Validierung
• Planwahl, Start, Pause, Beendigung und Übertragung
• Kommunikation zwischen API Owner und Consumer
• Self-Service mit angemessenen Guardrails

API Products

• Bündelung mehrerer V4-HTTP-Proxy-APIs
• Gemeinsame Pläne, einheitliche Subscription und Produktgrenzen
• Produktdokumentation, Lifecycle und Consumer-Erwartungen
• Einsatz für fachliche Pakete statt technischer Einzel-APIs

Branding, Inhalte und Betrieb

• Portalgestaltung, Navigation, Texte und Corporate Design
• Benutzerregistrierung, Gruppen, Rollen und Zugriffsbeschränkung
• Benachrichtigungen und organisatorischer Supportprozess
• Anwendungsbezogene Analytics, Logs und typische Supportfälle

Praxisübungen

1. Einen API-Katalog mit Kategorien, Sichtbarkeiten und konsistenter Dokumentation aufbauen.
2. Eine Anwendung registrieren, eine Subscription beantragen und den Freigabeprozess durchführen.
3. Credentials erzeugen, einen API-Aufruf testen und anschließend kontrolliert rotieren.
4. Mehrere V4-HTTP-APIs zu einem API Product bündeln und gemeinsam abonnieren.
5. Portalnavigation und Branding für eine definierte Consumer-Zielgruppe anpassen.
6. Einen typischen Consumer-Supportfall anhand von Subscription, Logs und Analytics bearbeiten.

Zielgruppe

API Product Owner, Developer-Experience-Teams, Portaladministratoren, API Owner, Plattformteams und technische Redakteure.

Voraussetzungen

Gravitee-APIM-Grundkenntnisse; Verständnis von API-Plänen und Subscriptions.

Arbeitsweise

Die Themen werden durch fachliche Einordnung, Demonstrationen und aufeinander aufbauende Übungen am System vermittelt. Konfigurationen werden geprüft, mit Negativtests belastet und anhand von Logs, Statusinformationen oder Metriken nachvollzogen. Die Übungen bilden einen durchgängigen technischen Anwendungsfall und vermeiden isolierte Klickfolgen ohne betrieblichen Zusammenhang.