Station

API-Veröffentlichung

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

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.

Ihre Route auf der Karte

Metrokarte

Select a cycle, station, or stakeholder to open its permanent method page.

StrategischGovernanceNutzerTechnischBenutzerfreundlichkeitBenutzerfreundlichkeitMarkteinblickeMarkteinblickeGeschäftszieleGeschäftszieleWettbewerbsanalyseWettbewerbsanalyseÖkosystem-VisionÖkosystem-VisionSkalierbare InfrastrukturSkalierbare InfrastrukturRechtliche Aspekte und Einhaltung von VorschriftenRechtliche Aspekte und Einhaltung von VorschriftenSicherheit und DatenschutzSicherheit und DatenschutzDesignstandardsDesignstandardsVendor ManagementVendor ManagementVertragsgestaltungVertragsgestaltungEntwicklungEntwicklungCI/CDCI/CDTestautomatisierungTestautomatisierungRelease ManagementRelease ManagementServicevereinbarungenServicevereinbarungenNutzerakzeptanzNutzerakzeptanzAPI-PromotionAPI-PromotionPartnerintegrationPartnerintegrationAPI-MentalitätAPI-MentalitätRollen und ZuständigkeitenRollen und ZuständigkeitenUpskillingUpskillingBetriebsleitlinienBetriebsleitlinienPortfoliomanagementPortfoliomanagementBudget- und RessourcenmanagementBudget- und RessourcenmanagementStrategie1API-ProduktstrategieNutzeranforderungen & Onboarding2API Consumer ExperienceArchitektur & Plattformentscheidungen3API-PlattformarchitekturLösungs- & Schnittstellendesign4API-DesignBereitstellung & Betrieb5API-BereitstellungQualitäts- & Bereitschaftssicherung6API-AuditVeröffentlichung & Enablement7API-VeröffentlichungMonitoring & Verbesserung8API-Monitoring &VerbesserungLinie GeschäftsmöglichkeitenLinie PlattformarchitekturAPI-EntwurfslinieBereitstellungslinieLinie Veröffentlichung & EnablementLinie Betriebsmodell

Selected station: Veröffentlichung & Enablement

Einzubeziehende Personen

Zugehörige Ressourcen

Ergebnisse

  • Veröffentlichung von APIs in der richtigen Umgebung (privat, Partner, öffentlich)
  • Klare API-Einführungs- und Registrierungsprozesse
  • Dokumentation, Sicherheitsmodelle und Richtlinien verfügbar
  • APIs bereit für Skalierung und Governance

Ablaufkriterien

Einstiegskriterien

  • Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.
  • Das Schnittstellendesign und die offengelegten Capabilities lassen sich klar auf Geschäftswert und Nutzerbedürfnisse zurückführen.
  • Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.
  • Das Schnittstellendesign folgt den vereinbarten Designstandards und Konventionen.
  • Der Schnittstellenvertrag wurde validiert und gegen funktionale und nicht-funktionale Anforderungen getestet.

Austrittskriterien

  • Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.
  • Audit-Ergebnisse und Maßnahmenentscheidungen wurden mit den relevanten Stakeholdern geteilt.
  • Die Capability ist bereit, über den gewählten Bereitstellungsmechanismus veröffentlicht oder ausgeliefert zu werden.
  • Nutzerorientierte Dokumentation und Onboarding-Materialien sind bereit.

So sieht Erfolg aus

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 Nutzersegmenten und den Sicherheits- und Compliance-Anforderungen.

  1. Veröffentlichen Sie APIs in den entsprechenden Gateways und Umgebungen, um die Wiederverwendbarkeit für mehrere Nutzer zu unterstützen.
  2. Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.
  3. Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind. — API Audit Checkliste

Metro lines

Zugehörige Ressourcen

Browse the resources selected for API-Veröffentlichung; the summary above explains how they support this station’s work.

Ressourcen

Resources for API-Veröffentlichung

checklist

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.

Ergebnisse

  • Besseres Verständnis der Grundsätze der API Audit Checkliste
  • Standardisierter Ansatz mit API Audit Checkliste
  • Verbesserte Umsetzung der entsprechenden API-Praktiken

So funktioniert es

  1. Verwenden Sie die API Audit Checkliste, um sicherzustellen, dass der API-Entwurf die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.
  2. Führen Sie Audits durch, um die Abdeckung des Lebenszyklus zu bewerten und sicherzustellen, dass die API den geschäftlichen, gestalterischen und betrieblichen Standards entspricht.
  3. Stellen Sie sicher, dass Dokumentation, Sicherheitsmodelle, Gateway-Konfiguration und gesetzliche Anforderungen klar definiert, validiert und durch Nachweise belegt sind.

Relevant cycles

Capability-Produktisierungszyklus

Ein Zyklus, um Geschäftsfähigkeiten in wiederverwendbare digitale Capabilities zu überführen, bevor die Umsetzungsweise gewählt wird.

API-Produktisierungszyklus

Die API-fokussierte APIOps-Cycles-Journey für Produktisierung, Design, Bereitstellung, Veröffentlichung und Verbesserung von APIs.

Integrationszyklus

Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird.

Automatisierungszyklus

Ein Zyklus zum Identifizieren, Entwerfen, Bereitstellen, Enablement und Verbessern von Automatisierungsmöglichkeiten.