APIs erfüllen interne und externe Standards

API-Audit

Stellen Sie sicher, dass APIs vor der Veröffentlichung und Bereitstellung den geschäftlichen, gestalterischen und betrieblichen Standards entsprechen.

Warum diese Station existiert?

APIs sind langlebige Produkte und müssen den Erwartungen hinsichtlich Qualität, Konsistenz und Compliance entsprechen. Das Audit verbindet Designentscheidungen, Implementierung und Betriebsbereitschaft mit definierten Standards und reduziert so Risiken vor der Bereitstellung.

So sieht Erfolg aus

Richten Sie einen konsistenten Audit-Prozess ein, der die API-Bereitschaft über alle Lebenszyklusphasen hinweg anhand definierter Kriterien, Nachweise und Standards bewertet. Stellen Sie sicher, dass Lücken frühzeitig erkannt und vor der Veröffentlichung behoben werden.

Startsignale (Eintrittskriterien)

Die gewählten API-Architektur- und Plattformmuster wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.
Die API-Design und die offengelegten Funktionen spiegeln klar den Geschäftswert und die Bedürfnisse der Benutzer wider.
Die API und ihre offengelegten Funktionen sind ausreichend beschrieben für Überprüfung, Auditierung und Onboarding.
Das API-Design folgt unseren gemeinsamen API-Produkt- und Design-Vorgaben.
Der API-Vertrag wurde getestet und erfüllt die funktionalen und nicht-funktionalen Anforderungen.

Gut gemacht, wenn (Austrittskriterien)

Die API besteht Compliance-, Sicherheits- und Audit-Prüfungen.
API-Auditberichte wurden mit relevanten Stakeholdern geteilt.
Die API ist bereit, für Verbraucher verfügbar gemacht zu werden.
Die API-Dokumentation ist vollständig und für die Veröffentlichung und das Onboarding geeignet.

So funktioniert es

Schritt

Schritt1/3

API Audit Checkliste

Eine lebenszyklusbasierte Checkliste zur Überprüfung der API-Bereitschaft in den Bereichen Design, Bereitstellung, Veröffentlichung und Compliance anhand definierter Audit-Kriterien und Nachweise.

Führen Sie Audits durch, um sicherzustellen, dass APIs vor der Veröffentlichung organisatorische, technische und rechtliche Standards erfüllen.

Checklist

Öffnen API Audit Checkliste

Beispiel ansehen