API-Veröffentlichung

Stellen Sie APIs mit der richtigen Dokumentation und den richtigen Prozessen sicher und klar für die richtige Zielgruppe bereit.

Ergebnisse

• Veröffentlichung von APIs in der richtigen Umgebung (privat, Partner, öffentlich)

Zugehörige Metro-Linien

• Veröffentlichungs- und Adoptionslinie

Warum das wichtig ist

Bei der Veröffentlichung geht es nicht nur um die Bereitstellung, sondern auch um die Auffindbarkeit, den Zugang und die Unterstützung. Wenn APIs nicht korrekt veröffentlicht werden, können sie nicht verwendet, wiederverwendet oder effektiv gesichert werden.

Eintrittskriterien

• Die API besteht Compliance-, Sicherheits- und Audit-Prüfungen.
• Auditberichte werden mit den Stakeholdern geteilt.
• Die API kann in den entsprechenden Gateways und Umgebungen veröffentlicht werden, um die Wiederverwendbarkeit für mehrere API-Nutzer zu unterstützen.
• Die API-Dokumentation ist vollständig und bereit zur Veröffentlichung.

Austrittskriterien

• Die API-Dokumentation ist vollständig und bereit zur Veröffentlichung.
• Prozesse für die API-Registrierung, den Support und die Kommunikation sind eingerichtet.
• Die rechtlichen und Compliance-Anforderungen sind für die Veröffentlichung präzise genug.

Wie es funktioniert

1. Veröffentlichen Sie APIs in den entsprechenden Gateways und Umgebungen, um die Wiederverwendbarkeit für mehrere API-Kunden zu unterstützen.
2. Dokumentieren Sie, wie die Verbraucher die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.
   Bewährte Praktiken beim API-Onboarding Bewährte Praktiken zur Optimierung des Onboarding-Prozesses für API-Kunden mit schrittweiser Anleitung zur Registrierung, Erkundung und zum ersten Anruf.
3. Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Verbraucher klar und verständlich sind.
   API Audit Checkliste Eine umfassende Checkliste zur Überprüfung der API-Bereitschaft vor der Veröffentlichung, die Design, Dokumentation, Sicherheit und die Einhaltung von Richtlinien abdeckt.

Bei Ihrer Arbeit anwenden

Ermöglichung der Veröffentlichung von APIs in der jeweiligen Umgebung mit klaren Registrierungs- und Zugriffsmechanismen (z. B. API-Schlüssel, OAuth, Abonnementpläne) je nach den API-Verbrauchersegmenten und den Sicherheits- und Compliance-Anforderungen.