Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird.
Unterstuetzt das Design wiederverwendbarer Integrations-Capabilities, bevor ein API-, Event-, Datei-, Stream-, Datenprodukt-, direkte Integrations- oder hybrider Implementierungsstil gewaehlt wird.
Ihre Route auf der Karte
Metrokarte
Select a cycle, station, or stakeholder to open its permanent method page.
Selected station: Strategie
Einzubeziehende Personen
Resources and canvases
Ablaufkriterien
Einstiegskriterien
Die Geschäftsziele sind definiert.
Die Capability-Möglichkeit wurde identifiziert und dokumentiert.
Austrittskriterien
Die gewählte Architektur, Plattform und der Implementierungsstil wurden mit den relevanten Architektur-, Sicherheits- und Plattform-Stakeholdern validiert.
Die Schnittstelle und ihre Capabilities sind ausreichend klar für Review, Auditierung und Onboarding dokumentiert.
Die Lösung besteht Qualitäts-, Sicherheits-, Compliance- und Bereitschaftsprüfungen.
Rahmen Sie die wiederverwendbare Integrations-Capability, den Geschaeftsbedarf, Ownership und erwartete Wiederverwendung, bevor der Implementierungsstil gewaehlt wird.
Integrations- und API-Arbeit springt oft zu früh zu einem technischen Muster. Diese Station hält das Team auf Geschäftsreise, Domänenverständnis, Wert, Wiederverwendungspotenzial, Ownership und Machbarkeit fokussiert, bevor APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration gewählt werden.
Erfassen Sie Integrationsnutzer, Anbieter-Verantwortlichkeiten, Onboarding-Bedarf, Serviceerwartungen und operative Einschränkungen.
Die richtige Architektur hängt von Nutzerzielen, Onboarding-Erwartungen, Service Levels, Datenqualität, Änderungsverträglichkeit, Observability, Support und Anbieterrestriktionen ab.
Waehlen Sie Integrationsarchitektur, Implementierungsstil und Plattformfaehigkeiten unter Beruecksichtigung von Einschraenkungen und Governance-Modell.
Eine wiederverwendbare Capability braucht Architekturentscheidungen, die zu Nutzeranforderungen, Sicherheitsanforderungen, Datenflüssen, Betriebsmodell und Plattformrealität passen.
Entwerfen Sie Schnittstellenvertrag, Schemas, Payloads und Interaktionsmuster fuer den gewaehlten Integrationsstil.
Gutes Design geht über die Benennung von Endpunkten hinaus. Es stellt sicher, dass die Schnittstelle nutzbar, konsistent, überprüfbar und auf Geschäfts- und Nutzeranforderungen zurückführbar ist.
Bauen, testen, automatisieren, deployen und betreiben Sie die Integrations-Capability mit dem gewaehlten Implementierungsstil und dem validierten Schnittstellenvertrag.
Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird.
Veroeffentlichen Sie die Integrations-Capability, damit Teams sie finden, bewerten, Zugriff beantragen, das Onboarding abschliessen, wiederverwenden und Support erhalten koennen.
Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.
Überwachen Sie Integrationszuverlässigkeit, Wiederverwendung, Incidents, Performance, Nutzerergebnisse und Verbesserungsbedarf.
Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern.
Publish this cycle
Export the page-specific template after reviewing the entity summary and supporting details above.
Confluence-Export
Publikationsvorlagen
Use Markdown for repositories and static sites, or Confluence-wiki markup for compatible Confluence pages.
Markdown
# Integrationszyklus question template
Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
## 1. Integrations-Capability-Strategie
Rahmen Sie die wiederverwendbare Integrations-Capability, den Geschaeftsbedarf, Ownership und erwartete Wiederverwendung, bevor der Implementierungsstil gewaehlt wird.
### Canvas questions
#### Customer Journey Canvas
Welche Customer Journey oder Partner Journey erzeugt den Bedarf für eine Capability oder Schnittstelle?
- **Persona**: Wer ist der typische Kunde oder Nutzer, der diese Reise erlebt?
- **Kunde erkennt Bedarf**: Wie erkennt der Kunde oder Nutzer ein Bedürfnis oder Problem?
- **Kundenbedarf wird erfüllt**: Wie wird der Bedarf des Kunden oder Nutzers letztlich erfüllt?
- **Customer Journey Schritte**: Welche Schritte durchläuft der Kunde bei der Reise?
- **Probleme**: Welche Probleme oder Pain Points erlebt der Kunde oder Nutzer?
- **Nutzen**: Welchen Gewinn oder Nutzen hat der Kunde?
- **Inputs & Outputs**: Was sind die Inputs und Outputs bei jedem Schritt?
- **Interaktions- und Verarbeitungsregeln**: Wie lauten die Interaktions- und Verarbeitungsregeln bei jedem Schritt?
#### Domain Canvas
Welche wesentlichen Entitäten, Begriffe und Fachregeln muss die Capability oder Schnittstelle respektieren?
- **Ausgewählte Customer Journey Schritte**: Welche Customer Journey Schritte sind für diese Domäne relevant?
- **Grundlegende Entitäten & geschäftliche Bedeutung**: Welches sind die wesentlichen Entitäten und ihre Bedeutung für das Geschäft?
- **Attribute & geschäftliche Wichtigkeit**: Welches sind die Schlüsselattribute der einzelnen Entitäten und ihre geschäftliche Wichtigkeit?
- **Beziehungen zwischen Entitäten**: Welche Beziehungen bestehen zwischen den Entitäten?
- **Fachregeln, Compliance und Integrität**: Welche Fachregeln sowie Compliance- und Integritätsanforderungen beziehen sich auf die Entitäten?
- **Überlegungen zu Sicherheit und Datenschutz**: Welche Überlegungen zur Sicherheit und zum Datenschutz gibt es im Zusammenhang mit den Entitäten?
#### Capability Value Proposition Canvas
Welche wiederverwendbare Capability würde Nutzern Wert liefern, ohne bereits zu entscheiden, ob sie als API, Event, Datei, Stream, Datenprodukt oder ein anderer Implementierungsstil bereitgestellt werden soll?
- **Nutzeraufgaben und Ergebnisse**: Was möchten Nutzer, Partner, Systeme oder Teams erreichen?
- **Nutzenstiftende Capability-Funktionen**: Welche Capability-Funktionen helfen Nutzern, bessere Ergebnisse, Geschwindigkeit, Automatisierung, Erkenntnisse, Reichweite oder Compliance zu erreichen?
- **Pain-Point-reduzierende Capability-Funktionen**: Welche Capability-Funktionen reduzieren Reibung, manuelle Arbeit, Fehler, Verzögerungen, Risiken oder Unsicherheit für Nutzer?
- **Wiederverwendbare Capabilities**: Welche wiederverwendbaren Geschäfts- oder Daten-Capabilities könnten diese Aufgaben, Nutzen und Pain Points über mehr als einen Nutzer oder Use Case hinweg unterstützen?
#### Capability Business Model Canvas
Wie tragfähig, wiederverwendbar, finanziert, verantwortet, unterstützt und auffindbar soll diese Integrations-Capability sein?
- **Wertversprechen der Capability**: Welchen Wert liefert diese wiederverwendbare Capability für Nutzer und für die Organisation oder das Ökosystem?
- **Nutzersegmente der Capability**: Wer sind die aktuellen und potenziellen Nutzer der Capability, einschließlich Teams, Partnern, Systemen, Produkten oder Datennutzern?
- **Nutzerinteraktion**: Wie werden Nutzer die Capability entdecken, bewerten, anfordern, onboarden, Unterstützung erhalten und Feedback geben?
- **Kanäle**: Über welche Kataloge, Portale, Marktplätze, Dokumentationsseiten, Support-Wege oder Governance-Prozesse interagieren Nutzer mit der Capability?
- **Schlüsselressourcen**: Welche Systeme, Datenbestände, Plattformen, Personen, Standards, Finanzierungen und operativen Fähigkeiten werden benötigt?
- **Schlüsselaktivitäten**: Was müssen Capability Owner und Produzenten tun, um die Capability zu gestalten, bereitzustellen, zu steuern, zu unterstützen und zu verbessern?
- **Schlüsselpartner**: Welche Partner aus Business, Technologie, Daten, Sicherheit, Recht, Plattform oder externen Organisationen werden benötigt, damit die Capability funktioniert?
- **Nutzen**: Welcher geschäftliche, operative, ökologische, wiederverwendungsbezogene, Compliance- oder Kostennutzen rechtfertigt die Capability?
- **Kosten**: Welche wesentlichen Kosten entstehen durch Aufbau, Betrieb, Governance, Support und Weiterentwicklung der Capability?
## 2. Integrationsnutzeranforderungen & Onboarding
Erfassen Sie Integrationsnutzer, Anbieter-Verantwortlichkeiten, Onboarding-Bedarf, Serviceerwartungen und operative Einschränkungen.
### Canvas questions
#### Consumer Experience Requirements Canvas
Welche Erfahrungs- und nichtfunktionalen Anforderungen benötigen Nutzer, bevor die beste Integrationsarchitektur entschieden wird?
- **Nutzerziele**: Welche Geschäfts-, Workflow-, Entscheidungs-, Automatisierungs- oder Datennutzungsziele haben die Nutzer?
- **Verfügbarkeit und Aktualität**: Wann muss die Capability verfügbar sein, wie aktuell müssen Informationen sein und welche Latenz- oder Bereitstellungsfenster sind relevant?
- **Volumen und Performance**: Welche Volumina an Requests, Events, Datensätzen, Dateien, Batches, Nutzern oder Transaktionen muss die Capability heute und künftig unterstützen?
- **Datenqualität und Konsistenz**: Welche Erwartungen an Genauigkeit, Vollständigkeit, Konsistenz, Reihenfolge, Deduplizierung, Abstimmung oder Validierung haben Nutzer?
- **Sicherheit, Datenschutz und Compliance**: Welche Anforderungen an Identität, Autorisierung, Vertraulichkeit, Datenresidenz, Einwilligung, Aufbewahrung, Audit oder Regulierung gelten?
- **Onboarding und Zugriff**: Wie sollen Nutzer die Capability finden, anfordern, testen, freigeben lassen und mit der Nutzung beginnen?
- **Änderungen und Versionierung**: Wie viel Änderungstoleranz haben Nutzer und welche Erwartungen an Vorankündigung, Kompatibilität, Migration oder Versionierung gelten?
- **Observability und Support**: Welche Überwachung, Statusinformationen, Nachvollziehbarkeit, Sichtbarkeit der Datenqualität, Unterstützung, Verantwortlichkeiten und Incident-Kommunikation benötigen Nutzer?
- **Recovery und Kontinuität**: Welche Erwartungen an Replay, Retry, Abstimmung, Backup, Fallback, Kontinuität oder manuelle Wiederherstellung müssen unterstützt werden?
- **Architekturimplikationen**: Was bedeuten diese Anforderungen für mögliche Architekturstile wie APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration?
### Other related resources
- **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. Integrationsarchitektur & Plattformentscheidungen
Waehlen Sie Integrationsarchitektur, Implementierungsstil und Plattformfaehigkeiten unter Beruecksichtigung von Einschraenkungen und Governance-Modell.
### Canvas questions
#### Business Impact Canvas
Welche geschäftlichen Auswirkungen kann ein Ausfall oder Fehlverhalten der Capability oder Schnittstelle haben?
- **Risiken der Verfügbarkeit**: Was sind die potenziellen Risiken für die API-Verfügbarkeit?
- **Reduzierung von Risiken der Verfügbarkeit**: Wie lassen sich Verfügbarkeitsrisiken reduzieren?
- **Sicherheitsrisiken**: Welche potenziellen Sicherheitsrisiken sind mit der API assoziiert?
- **Reduktion der Sicherheitsrisiken**: Wie lassen sich Sicherheitsrisiken reduzieren?
- **Datenrisiken**: Welche potenziellen Risiken bestehen für die Datenintegrität oder -Vertraulichkeit?
- **Reduktion der Datenrisiken**: Wie lassen sich Datenrisiken reduzieren?
#### Location Canvas
Welche geopolitischen, regulatorischen, Netzwerk- und Vertrauensgrenzen betreffen diese Capability oder Schnittstelle?
- **Standort-/Vertrauensgruppen**: Welche geopolitischen, regulatorischen, netzwerkbezogenen oder vertrauensbezogenen Gruppen sind relevant?
- **Gruppenmerkmale**: Was sind die Merkmale dieser Gruppen, wie z. B. Standort, Vertrauensstufe oder Netzwerkexposition?
- **Relevante Standorte / Zonen**: Was sind die relevanten Standorte, Zonen oder Umgebungen innerhalb jeder Gruppe?
- **Standort-/Zonenmerkmale**: Was sind die Merkmale dieser Standorte oder Zonen, wie z. B. Eigentumsverhältnisse, Region oder Exposition?
- **Netzwerk- / Regulierungsentfernungen**: Welche Latenz-, Vertrauens-, Regulierungs- oder Konnektivitätsentfernungen bestehen zwischen den Standorten?
- **Entfernungsmerkmale**: Was sind die Merkmale dieser Entfernungen, wie z. B. Latenzempfindlichkeit, Aufenthaltsbeschränkungen oder Vertrauensgrenzen?
- **Konnektivitätsendpunkte**: Welche Konnektivitätsendpunkte oder Schnittstellen sind mit den Standorten verbunden?
- **Endpunktzugriffseigenschaften**: Welche Eigenschaften weisen diese Endpunkte auf, wie z. B. Sichtbarkeit, Protokoll, Sicherheit oder Zugriffsbeschränkungen?
#### Capacity Canvas
Welche Kapazität ist erforderlich, um die Nutzung der Capability oder Schnittstelle zu unterstützen?
- **Aktuelles Geschäftsvolumen**: Wie hoch sind das aktuelle Geschäftsvolumen und die Transaktionsraten?
- **Zukünftige Konsumtrends**: Was sind die erwarteten künftigen Konsumtrends?
- **Spitzenlast- und Verfügbarkeitsanforderungen**: Was sind die Spitzenlast- und Verfügbarkeitsanforderungen?
- **Caching-Strategien**: Welche Caching-Strategien können zur Performanceoptimierung eingesetzt werden?
- **Strategien zur Ratenbegrenzung**: Welche Strategien zur Ratenbegrenzung können genutzt werden, um die Nutzung zu steuern?
- **Strategien zur Skalierung**: Welche Strategien zur Skalierung können eingesetzt werden, um das Wachstum zu unterstützen?
### Other related resources
- **Leitlinien für die Integration von Partnern**: Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.
## 4. Integrationsdesign
Entwerfen Sie Schnittstellenvertrag, Schemas, Payloads und Interaktionsmuster fuer den gewaehlten Integrationsstil.
### Canvas questions
#### Domain Canvas
Welche wesentlichen Entitäten, Begriffe und Fachregeln muss die Capability oder Schnittstelle respektieren?
- **Ausgewählte Customer Journey Schritte**: Welche Customer Journey Schritte sind für diese Domäne relevant?
- **Grundlegende Entitäten & geschäftliche Bedeutung**: Welches sind die wesentlichen Entitäten und ihre Bedeutung für das Geschäft?
- **Attribute & geschäftliche Wichtigkeit**: Welches sind die Schlüsselattribute der einzelnen Entitäten und ihre geschäftliche Wichtigkeit?
- **Beziehungen zwischen Entitäten**: Welche Beziehungen bestehen zwischen den Entitäten?
- **Fachregeln, Compliance und Integrität**: Welche Fachregeln sowie Compliance- und Integritätsanforderungen beziehen sich auf die Entitäten?
- **Überlegungen zu Sicherheit und Datenschutz**: Welche Überlegungen zur Sicherheit und zum Datenschutz gibt es im Zusammenhang mit den Entitäten?
#### Interaction Canvas
Welche Arten von Interaktionen muss diese Capability oder Schnittstelle unterstützen, bevor ein konkretes Protokolldesign gewählt wird?
- **CRUD Interaktionen**: Sind hier Interaktionen im CRUD-Stil erforderlich?
- **CRUD Input- & Output-Modelle**: Was sind die Eingabe- und Ausgabemodelle für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
- **CRUD Verarbeitung & Validierung**: Was sind die Verarbeitungs- und Validierungsregeln für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
- **Abfragegesteuerte Interaktionen**: Welche Lese- oder Abfrageinteraktionen sind erforderlich, um Nutzerfragen zu beantworten?
- **Abfragegesteuerte Input- & Output-Modelle**: Was sind die Eingabe- und Ausgabemodelle für die abfragegesteuerten Interaktionen?
- **Abfragegesteuerte Verarbeitung & Validierung**: Was sind die Verarbeitungs- und Validierungsregeln für die abfragegesteuerten Interaktionen?
- **Befehlsgesteuerte Interaktionen**: Welche Befehle zur Zustandsänderung sind gegebenenfalls erforderlich?
- **Befehlsgesteuerte Input- & Output-Modelle**: Was sind die Eingabe- und Ausgabemodelle für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
- **Befehlsgesteuerte Verarbeitung & Validierung**: Was sind die Verarbeitungs- und Validierungsregeln für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
- **Eventgesteuerte Interaktionen**: Welche Ereignisse müssen gegebenenfalls veröffentlicht oder verarbeitet werden?
- **Eventgesteuerte Input- & Output-Modelle**: Was sind die Eingabe- und Ausgabemodelle für die ereignisgesteuerten Interaktionen, falls dieser Stil erforderlich ist?
- **Eventgesteuerte Verarbeitung & Validierung**: Was sind die Verarbeitungs- und Validierungsregeln für die ereignisgesteuerten Interaktionen, falls dieser Stil benötigt wird?
#### REST Canvas
Wie kann die API nach RESTful-Prinzipien gestaltet werden?
- **API-Ressourcen**: Was sind die Schlüsselressourcen, die von der API bereitgestellt werden?
- **API-Ressourcenmodell**: Wie sieht die Struktur des API-Ressourcenmodells aus?
- **HTTP-Methoden der API**: Welche HTTP-Methoden werden für die Interaktion mit den API-Ressourcen verwendet?
- **HTTP-Methoden-Beispiel**: Geben Sie für jede HTTP-Methode ein Beispiel für eine API-Anfrage und -Antwort an.
#### Event Canvas
Welche Ereignisse sind für die Capability oder Schnittstelle relevant und wie werden sie verarbeitet?
- **Nutzeraufgabe / Auslöser**: Welche Nutzeraktion oder welches Systemereignis löst diese Ereignisoperation aus?
- **Input / Event-Payload**: Welche Daten sind in der eingehenden Event-Payload enthalten? Geben Sie die Schlüsselattribute an.
- **Verarbeitung / Logik**: Beschreiben Sie die Verarbeitungslogik der Backend-Systeme, einschließlich Validierungen, Transformationen oder Routing-Entscheidungen.
- **Output / Event-Ergebnis**: Welches Event oder welche Bestätigungsmeldung wird erzeugt? Geben Sie die Attribute des Output-Payloads an.
#### GraphQL Canvas
Wie kann die API nach GraphQL-Prinzipien gestaltet werden?
- **API-Name**: Wie lautet der Name der GraphQL-API oder des Endpunkts?
- **Ziele der API-Nutzer**: Welche Probleme versuchen API-Nutzer zu lösen? Welche Daten benötigen sie?
- **Schlüsseltypen**: Welche zentralen Typen werden bereitgestellt (z. B. Nutzer, Bestellung, Produkt)?
- **Beziehungen**: Wie stehen die Typen in verschachtelten Abfragen zueinander?
- **Abfragen**: Welche typischen Abfragen sollten unterstützt werden?
- **Mutationen**: Welche Operationen verändern Daten (z.B. erstellen, aktualisieren, löschen)?
- **Subscriptions**: Gibt es Echtzeit-Updates oder Ereignisse, die Nutzer abonnieren können?
- **Autorisierungsregeln**: Wer darf auf welche Felder oder Typen zugreifen?
- **Einschränkungen für Nutzer**: Gibt es Paginierungs-, Filter- oder Ratenbegrenzungen?
- **Notizen / Offene Fragen**: Gibt es noch offene Entscheidungen oder Integrationsüberlegungen?
### Other related resources
- **Leitfaden zur Auswahl des Implementierungsstils**: Orientierung zur Auswahl zwischen API, Event, Datei, Stream, Datenprodukt, direkter Integration oder hybriden Implementierungsstilen auf Grundlage von Anforderungen und Rahmenbedingungen.
- **Vertrag Erstes Design**: Ein Leitfaden, der für API-first-Ansätze plädiert, bei denen formale Verträge (z. B. OpenAPI) verwendet werden, um die Beteiligten vor der Entwicklung aufeinander abzustimmen.
## 5. Integrationsbereitstellung & Betrieb
Bauen, testen, automatisieren, deployen und betreiben Sie die Integrations-Capability mit dem gewaehlten Implementierungsstil und dem validierten Schnittstellenvertrag.
### Station questions
- Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.
- Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.
- Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.
- Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.
- Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.
- Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass die API die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.
- Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.
- Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird.
### Other related resources
- **Bewährte Praktiken der API-Entwicklung**: Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.
- **Bewährte Praktiken für API-Tests**: Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.
- **APIOps CI/CD für APIs**: Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.
- **Bewährte Praktiken für die API-Sicherheit**: Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.
- **Leitlinien für die Integration von Partnern**: Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.
## 6. Integrationsbereitschaftssicherung
Sichern Sie Integrationsbereitschaft, Governance, Qualität, Sicherheit, Compliance und operative Nachweise vor der Veröffentlichung ab.
### Station questions
- Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.
- Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.
- Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.
- Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.
- Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung.
### Other related resources
- **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.
- **Bewährte Praktiken zur API-Einhaltung**: Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.
## 7. Integrationsveroeffentlichung & Enablement
Veroeffentlichen Sie die Integrations-Capability, damit Teams sie finden, bewerten, Zugriff beantragen, das Onboarding abschliessen, wiederverwenden und Support erhalten koennen.
### Station questions
- Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.
- Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.
- Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.
- Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.
- Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.
### Other related resources
- **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.
- **Vorlage für eine Dienstleistungsvereinbarung**: Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.
## 8. Integrationsmonitoring & Verbesserung
Überwachen Sie Integrationszuverlässigkeit, Wiederverwendung, Incidents, Performance, Nutzerergebnisse und Verbesserungsbedarf.
### Station questions
- Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.
- Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.
- Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.
- Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.
- Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern.
### Other related resources
- **API-Metriken und -Analysen**: Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.
- **Strategien für das Engagement der API-Gemeinschaft**: Ein Leitfaden für die Förderung der API-Annahme durch die Pflege von Gemeinschaften durch Inhalte, Support-Kanäle, Feedback-Schleifen und Strategien für soziales Engagement.
Confluence-wiki
h1. Integrationszyklus question template
Ein Zyklus zur Produktisierung wiederverwendbarer Integrations-Capabilities, bevor der Implementierungsstil gewaehlt wird.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
h2. 1. Integrations-Capability-Strategie
Rahmen Sie die wiederverwendbare Integrations-Capability, den Geschaeftsbedarf, Ownership und erwartete Wiederverwendung, bevor der Implementierungsstil gewaehlt wird.
h3. Canvas questions
#### Customer Journey Canvas
Welche Customer Journey oder Partner Journey erzeugt den Bedarf für eine Capability oder Schnittstelle?
* *Persona*: Wer ist der typische Kunde oder Nutzer, der diese Reise erlebt?
* *Kunde erkennt Bedarf*: Wie erkennt der Kunde oder Nutzer ein Bedürfnis oder Problem?
* *Kundenbedarf wird erfüllt*: Wie wird der Bedarf des Kunden oder Nutzers letztlich erfüllt?
* *Customer Journey Schritte*: Welche Schritte durchläuft der Kunde bei der Reise?
* *Probleme*: Welche Probleme oder Pain Points erlebt der Kunde oder Nutzer?
* *Nutzen*: Welchen Gewinn oder Nutzen hat der Kunde?
* *Inputs & Outputs*: Was sind die Inputs und Outputs bei jedem Schritt?
* *Interaktions- und Verarbeitungsregeln*: Wie lauten die Interaktions- und Verarbeitungsregeln bei jedem Schritt?
#### Domain Canvas
Welche wesentlichen Entitäten, Begriffe und Fachregeln muss die Capability oder Schnittstelle respektieren?
* *Ausgewählte Customer Journey Schritte*: Welche Customer Journey Schritte sind für diese Domäne relevant?
* *Grundlegende Entitäten & geschäftliche Bedeutung*: Welches sind die wesentlichen Entitäten und ihre Bedeutung für das Geschäft?
* *Attribute & geschäftliche Wichtigkeit*: Welches sind die Schlüsselattribute der einzelnen Entitäten und ihre geschäftliche Wichtigkeit?
* *Beziehungen zwischen Entitäten*: Welche Beziehungen bestehen zwischen den Entitäten?
* *Fachregeln, Compliance und Integrität*: Welche Fachregeln sowie Compliance- und Integritätsanforderungen beziehen sich auf die Entitäten?
* *Überlegungen zu Sicherheit und Datenschutz*: Welche Überlegungen zur Sicherheit und zum Datenschutz gibt es im Zusammenhang mit den Entitäten?
#### Capability Value Proposition Canvas
Welche wiederverwendbare Capability würde Nutzern Wert liefern, ohne bereits zu entscheiden, ob sie als API, Event, Datei, Stream, Datenprodukt oder ein anderer Implementierungsstil bereitgestellt werden soll?
* *Nutzeraufgaben und Ergebnisse*: Was möchten Nutzer, Partner, Systeme oder Teams erreichen?
* *Nutzenstiftende Capability-Funktionen*: Welche Capability-Funktionen helfen Nutzern, bessere Ergebnisse, Geschwindigkeit, Automatisierung, Erkenntnisse, Reichweite oder Compliance zu erreichen?
* *Pain-Point-reduzierende Capability-Funktionen*: Welche Capability-Funktionen reduzieren Reibung, manuelle Arbeit, Fehler, Verzögerungen, Risiken oder Unsicherheit für Nutzer?
* *Wiederverwendbare Capabilities*: Welche wiederverwendbaren Geschäfts- oder Daten-Capabilities könnten diese Aufgaben, Nutzen und Pain Points über mehr als einen Nutzer oder Use Case hinweg unterstützen?
#### Capability Business Model Canvas
Wie tragfähig, wiederverwendbar, finanziert, verantwortet, unterstützt und auffindbar soll diese Integrations-Capability sein?
* *Wertversprechen der Capability*: Welchen Wert liefert diese wiederverwendbare Capability für Nutzer und für die Organisation oder das Ökosystem?
* *Nutzersegmente der Capability*: Wer sind die aktuellen und potenziellen Nutzer der Capability, einschließlich Teams, Partnern, Systemen, Produkten oder Datennutzern?
* *Nutzerinteraktion*: Wie werden Nutzer die Capability entdecken, bewerten, anfordern, onboarden, Unterstützung erhalten und Feedback geben?
* *Kanäle*: Über welche Kataloge, Portale, Marktplätze, Dokumentationsseiten, Support-Wege oder Governance-Prozesse interagieren Nutzer mit der Capability?
* *Schlüsselressourcen*: Welche Systeme, Datenbestände, Plattformen, Personen, Standards, Finanzierungen und operativen Fähigkeiten werden benötigt?
* *Schlüsselaktivitäten*: Was müssen Capability Owner und Produzenten tun, um die Capability zu gestalten, bereitzustellen, zu steuern, zu unterstützen und zu verbessern?
* *Schlüsselpartner*: Welche Partner aus Business, Technologie, Daten, Sicherheit, Recht, Plattform oder externen Organisationen werden benötigt, damit die Capability funktioniert?
* *Nutzen*: Welcher geschäftliche, operative, ökologische, wiederverwendungsbezogene, Compliance- oder Kostennutzen rechtfertigt die Capability?
* *Kosten*: Welche wesentlichen Kosten entstehen durch Aufbau, Betrieb, Governance, Support und Weiterentwicklung der Capability?
h2. 2. Integrationsnutzeranforderungen & Onboarding
Erfassen Sie Integrationsnutzer, Anbieter-Verantwortlichkeiten, Onboarding-Bedarf, Serviceerwartungen und operative Einschränkungen.
h3. Canvas questions
#### Consumer Experience Requirements Canvas
Welche Erfahrungs- und nichtfunktionalen Anforderungen benötigen Nutzer, bevor die beste Integrationsarchitektur entschieden wird?
* *Nutzerziele*: Welche Geschäfts-, Workflow-, Entscheidungs-, Automatisierungs- oder Datennutzungsziele haben die Nutzer?
* *Verfügbarkeit und Aktualität*: Wann muss die Capability verfügbar sein, wie aktuell müssen Informationen sein und welche Latenz- oder Bereitstellungsfenster sind relevant?
* *Volumen und Performance*: Welche Volumina an Requests, Events, Datensätzen, Dateien, Batches, Nutzern oder Transaktionen muss die Capability heute und künftig unterstützen?
* *Datenqualität und Konsistenz*: Welche Erwartungen an Genauigkeit, Vollständigkeit, Konsistenz, Reihenfolge, Deduplizierung, Abstimmung oder Validierung haben Nutzer?
* *Sicherheit, Datenschutz und Compliance*: Welche Anforderungen an Identität, Autorisierung, Vertraulichkeit, Datenresidenz, Einwilligung, Aufbewahrung, Audit oder Regulierung gelten?
* *Onboarding und Zugriff*: Wie sollen Nutzer die Capability finden, anfordern, testen, freigeben lassen und mit der Nutzung beginnen?
* *Änderungen und Versionierung*: Wie viel Änderungstoleranz haben Nutzer und welche Erwartungen an Vorankündigung, Kompatibilität, Migration oder Versionierung gelten?
* *Observability und Support*: Welche Überwachung, Statusinformationen, Nachvollziehbarkeit, Sichtbarkeit der Datenqualität, Unterstützung, Verantwortlichkeiten und Incident-Kommunikation benötigen Nutzer?
* *Recovery und Kontinuität*: Welche Erwartungen an Replay, Retry, Abstimmung, Backup, Fallback, Kontinuität oder manuelle Wiederherstellung müssen unterstützt werden?
* *Architekturimplikationen*: Was bedeuten diese Anforderungen für mögliche Architekturstile wie APIs, Events, Dateien, Streams, Datenprodukte oder direkte Integration?
h3. Other related resources
* *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.
h2. 3. Integrationsarchitektur & Plattformentscheidungen
Waehlen Sie Integrationsarchitektur, Implementierungsstil und Plattformfaehigkeiten unter Beruecksichtigung von Einschraenkungen und Governance-Modell.
h3. Canvas questions
#### Business Impact Canvas
Welche geschäftlichen Auswirkungen kann ein Ausfall oder Fehlverhalten der Capability oder Schnittstelle haben?
* *Risiken der Verfügbarkeit*: Was sind die potenziellen Risiken für die API-Verfügbarkeit?
* *Reduzierung von Risiken der Verfügbarkeit*: Wie lassen sich Verfügbarkeitsrisiken reduzieren?
* *Sicherheitsrisiken*: Welche potenziellen Sicherheitsrisiken sind mit der API assoziiert?
* *Reduktion der Sicherheitsrisiken*: Wie lassen sich Sicherheitsrisiken reduzieren?
* *Datenrisiken*: Welche potenziellen Risiken bestehen für die Datenintegrität oder -Vertraulichkeit?
* *Reduktion der Datenrisiken*: Wie lassen sich Datenrisiken reduzieren?
#### Location Canvas
Welche geopolitischen, regulatorischen, Netzwerk- und Vertrauensgrenzen betreffen diese Capability oder Schnittstelle?
* *Standort-/Vertrauensgruppen*: Welche geopolitischen, regulatorischen, netzwerkbezogenen oder vertrauensbezogenen Gruppen sind relevant?
* *Gruppenmerkmale*: Was sind die Merkmale dieser Gruppen, wie z. B. Standort, Vertrauensstufe oder Netzwerkexposition?
* *Relevante Standorte / Zonen*: Was sind die relevanten Standorte, Zonen oder Umgebungen innerhalb jeder Gruppe?
* *Standort-/Zonenmerkmale*: Was sind die Merkmale dieser Standorte oder Zonen, wie z. B. Eigentumsverhältnisse, Region oder Exposition?
* *Netzwerk- / Regulierungsentfernungen*: Welche Latenz-, Vertrauens-, Regulierungs- oder Konnektivitätsentfernungen bestehen zwischen den Standorten?
* *Entfernungsmerkmale*: Was sind die Merkmale dieser Entfernungen, wie z. B. Latenzempfindlichkeit, Aufenthaltsbeschränkungen oder Vertrauensgrenzen?
* *Konnektivitätsendpunkte*: Welche Konnektivitätsendpunkte oder Schnittstellen sind mit den Standorten verbunden?
* *Endpunktzugriffseigenschaften*: Welche Eigenschaften weisen diese Endpunkte auf, wie z. B. Sichtbarkeit, Protokoll, Sicherheit oder Zugriffsbeschränkungen?
#### Capacity Canvas
Welche Kapazität ist erforderlich, um die Nutzung der Capability oder Schnittstelle zu unterstützen?
* *Aktuelles Geschäftsvolumen*: Wie hoch sind das aktuelle Geschäftsvolumen und die Transaktionsraten?
* *Zukünftige Konsumtrends*: Was sind die erwarteten künftigen Konsumtrends?
* *Spitzenlast- und Verfügbarkeitsanforderungen*: Was sind die Spitzenlast- und Verfügbarkeitsanforderungen?
* *Caching-Strategien*: Welche Caching-Strategien können zur Performanceoptimierung eingesetzt werden?
* *Strategien zur Ratenbegrenzung*: Welche Strategien zur Ratenbegrenzung können genutzt werden, um die Nutzung zu steuern?
* *Strategien zur Skalierung*: Welche Strategien zur Skalierung können eingesetzt werden, um das Wachstum zu unterstützen?
h3. Other related resources
* *Leitlinien für die Integration von Partnern*: Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.
h2. 4. Integrationsdesign
Entwerfen Sie Schnittstellenvertrag, Schemas, Payloads und Interaktionsmuster fuer den gewaehlten Integrationsstil.
h3. Canvas questions
#### Domain Canvas
Welche wesentlichen Entitäten, Begriffe und Fachregeln muss die Capability oder Schnittstelle respektieren?
* *Ausgewählte Customer Journey Schritte*: Welche Customer Journey Schritte sind für diese Domäne relevant?
* *Grundlegende Entitäten & geschäftliche Bedeutung*: Welches sind die wesentlichen Entitäten und ihre Bedeutung für das Geschäft?
* *Attribute & geschäftliche Wichtigkeit*: Welches sind die Schlüsselattribute der einzelnen Entitäten und ihre geschäftliche Wichtigkeit?
* *Beziehungen zwischen Entitäten*: Welche Beziehungen bestehen zwischen den Entitäten?
* *Fachregeln, Compliance und Integrität*: Welche Fachregeln sowie Compliance- und Integritätsanforderungen beziehen sich auf die Entitäten?
* *Überlegungen zu Sicherheit und Datenschutz*: Welche Überlegungen zur Sicherheit und zum Datenschutz gibt es im Zusammenhang mit den Entitäten?
#### Interaction Canvas
Welche Arten von Interaktionen muss diese Capability oder Schnittstelle unterstützen, bevor ein konkretes Protokolldesign gewählt wird?
* *CRUD Interaktionen*: Sind hier Interaktionen im CRUD-Stil erforderlich?
* *CRUD Input- & Output-Modelle*: Was sind die Eingabe- und Ausgabemodelle für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
* *CRUD Verarbeitung & Validierung*: Was sind die Verarbeitungs- und Validierungsregeln für die CRUD-Interaktionen, falls dieser Stil benötigt wird?
* *Abfragegesteuerte Interaktionen*: Welche Lese- oder Abfrageinteraktionen sind erforderlich, um Nutzerfragen zu beantworten?
* *Abfragegesteuerte Input- & Output-Modelle*: Was sind die Eingabe- und Ausgabemodelle für die abfragegesteuerten Interaktionen?
* *Abfragegesteuerte Verarbeitung & Validierung*: Was sind die Verarbeitungs- und Validierungsregeln für die abfragegesteuerten Interaktionen?
* *Befehlsgesteuerte Interaktionen*: Welche Befehle zur Zustandsänderung sind gegebenenfalls erforderlich?
* *Befehlsgesteuerte Input- & Output-Modelle*: Was sind die Eingabe- und Ausgabemodelle für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
* *Befehlsgesteuerte Verarbeitung & Validierung*: Was sind die Verarbeitungs- und Validierungsregeln für die befehlsgesteuerten Interaktionen, falls dieser Stil benötigt wird?
* *Eventgesteuerte Interaktionen*: Welche Ereignisse müssen gegebenenfalls veröffentlicht oder verarbeitet werden?
* *Eventgesteuerte Input- & Output-Modelle*: Was sind die Eingabe- und Ausgabemodelle für die ereignisgesteuerten Interaktionen, falls dieser Stil erforderlich ist?
* *Eventgesteuerte Verarbeitung & Validierung*: Was sind die Verarbeitungs- und Validierungsregeln für die ereignisgesteuerten Interaktionen, falls dieser Stil benötigt wird?
#### REST Canvas
Wie kann die API nach RESTful-Prinzipien gestaltet werden?
* *API-Ressourcen*: Was sind die Schlüsselressourcen, die von der API bereitgestellt werden?
* *API-Ressourcenmodell*: Wie sieht die Struktur des API-Ressourcenmodells aus?
* *HTTP-Methoden der API*: Welche HTTP-Methoden werden für die Interaktion mit den API-Ressourcen verwendet?
* *HTTP-Methoden-Beispiel*: Geben Sie für jede HTTP-Methode ein Beispiel für eine API-Anfrage und -Antwort an.
#### Event Canvas
Welche Ereignisse sind für die Capability oder Schnittstelle relevant und wie werden sie verarbeitet?
* *Nutzeraufgabe / Auslöser*: Welche Nutzeraktion oder welches Systemereignis löst diese Ereignisoperation aus?
* *Input / Event-Payload*: Welche Daten sind in der eingehenden Event-Payload enthalten? Geben Sie die Schlüsselattribute an.
* *Verarbeitung / Logik*: Beschreiben Sie die Verarbeitungslogik der Backend-Systeme, einschließlich Validierungen, Transformationen oder Routing-Entscheidungen.
* *Output / Event-Ergebnis*: Welches Event oder welche Bestätigungsmeldung wird erzeugt? Geben Sie die Attribute des Output-Payloads an.
#### GraphQL Canvas
Wie kann die API nach GraphQL-Prinzipien gestaltet werden?
* *API-Name*: Wie lautet der Name der GraphQL-API oder des Endpunkts?
* *Ziele der API-Nutzer*: Welche Probleme versuchen API-Nutzer zu lösen? Welche Daten benötigen sie?
* *Schlüsseltypen*: Welche zentralen Typen werden bereitgestellt (z. B. Nutzer, Bestellung, Produkt)?
* *Beziehungen*: Wie stehen die Typen in verschachtelten Abfragen zueinander?
* *Abfragen*: Welche typischen Abfragen sollten unterstützt werden?
* *Mutationen*: Welche Operationen verändern Daten (z.B. erstellen, aktualisieren, löschen)?
* *Subscriptions*: Gibt es Echtzeit-Updates oder Ereignisse, die Nutzer abonnieren können?
* *Autorisierungsregeln*: Wer darf auf welche Felder oder Typen zugreifen?
* *Einschränkungen für Nutzer*: Gibt es Paginierungs-, Filter- oder Ratenbegrenzungen?
* *Notizen / Offene Fragen*: Gibt es noch offene Entscheidungen oder Integrationsüberlegungen?
h3. Other related resources
* *Leitfaden zur Auswahl des Implementierungsstils*: Orientierung zur Auswahl zwischen API, Event, Datei, Stream, Datenprodukt, direkter Integration oder hybriden Implementierungsstilen auf Grundlage von Anforderungen und Rahmenbedingungen.
* *Vertrag Erstes Design*: Ein Leitfaden, der für API-first-Ansätze plädiert, bei denen formale Verträge (z. B. OpenAPI) verwendet werden, um die Beteiligten vor der Entwicklung aufeinander abzustimmen.
h2. 5. Integrationsbereitstellung & Betrieb
Bauen, testen, automatisieren, deployen und betreiben Sie die Integrations-Capability mit dem gewaehlten Implementierungsstil und dem validierten Schnittstellenvertrag.
h3. Station questions
* Nutzen Sie Entwicklungspraktiken, um den validierten Schnittstellenvertrag mit etablierten Frameworks, Bibliotheken und Teamstandards umzusetzen.
* Erstellen Sie die API-Implementierung auf Basis des validierten Vertrags unter Verwendung etablierter Frameworks, Bibliotheken und Teamstandards.
* Testen Sie APIs auf Funktionalität, Sicherheit und Leistung mit automatisierten Testwerkzeugen.
* Verwenden Sie CI/CD-Pipelines, um Build-, Test- und Bereitstellungsprozesse zu automatisieren und so konsistente Qualität und Nachvollziehbarkeit zu gewährleisten.
* Stellen Sie sicher, dass APIs die Sicherheits- und Compliance-Anforderungen durch automatische Prüfungen und Audits erfüllen.
* Verwenden Sie die API-Audit-Checkliste, um sicherzustellen, dass die API die funktionalen und nicht-funktionalen Anforderungen erfüllt, einschließlich Sicherheit, Leistung und Compliance.
* Wenden Sie Guidance für Umsetzung, Tests, CI/CD, Betrieb und Sicherheit auf die gewählte Umsetzungsweise an.
* Eine wiederverwendbare Capability braucht zuverlässige Bereitstellung und Betrieb, unabhängig davon, ob sie als API, Event-Stream, Dateiaustausch, Datenprodukt oder direkte Integration umgesetzt wird.
h3. Other related resources
* *Bewährte Praktiken der API-Entwicklung*: Implementierungsleitfaden zur Umsetzung eines validierten API-Vertrags in eine konsistente, wartbare API-Codebasis unter Verwendung von Standardbibliotheken, wiederverwendbaren Mustern und aufeinander abgestimmten Entwicklungsabläufen.
* *Bewährte Praktiken für API-Tests*: Richtlinien für die Implementierung automatisierter Funktions-, Leistungs- und Sicherheitstests während des gesamten API-Lebenszyklus.
* *APIOps CI/CD für APIs*: Bereitstellungsleitfaden, der die Aufgaben des API-Lebenszyklus - Entwurf, Tests, Governance - in die Pipelines für die kontinuierliche Integration und Bereitstellung integriert.
* *Bewährte Praktiken für die API-Sicherheit*: Eine Reihe praktikabler Kontrollen zur Sicherung von APIs, einschließlich Authentifizierung, Autorisierung, Verschlüsselung, Ratenbegrenzung und Konformitätsprüfungen auf Pipeline-Ebene.
* *Leitlinien für die Integration von Partnern*: Integrationschecklisten und Kommunikationsmuster zur Verwaltung der technischen und rechtlichen Aspekte von API-Beziehungen mit Dritten.
h2. 6. Integrationsbereitschaftssicherung
Sichern Sie Integrationsbereitschaft, Governance, Qualität, Sicherheit, Compliance und operative Nachweise vor der Veröffentlichung ab.
h3. Station questions
* Nutzen Sie Checklisten, Linters, Tests und Reviews, um Konsistenz, Standards, Sicherheit, Performance und Compliance zu prüfen.
* Verwenden Sie Checklisten, Linters und Testwerkzeuge, um die Konsistenz und Compliance mit den Standards zu überprüfen.
* Zusammenarbeit mit Governance-Teams und Domänenexperten, um sicherzustellen, dass APIs für die Produktion bereit sind.
* Nutzen Sie Audit- und Compliance-Ressourcen, um sicherzustellen, dass die Capability kontrolliert veröffentlicht und wiederverwendet werden kann.
* Wiederverwendbare Capabilities erzeugen operative, datenbezogene, sicherheitsrelevante, datenschutzbezogene, Compliance- und Nutzerimpact-Risiken. Bereitschaftsprüfungen reduzieren Überraschungen vor Veröffentlichung oder produktiver Nutzung.
h3. Other related resources
* *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.
* *Bewährte Praktiken zur API-Einhaltung*: Sicherstellen, dass APIs durch Dokumentation, Kontrollen und automatisierte Validierungen die rechtlichen, regulatorischen und internen Anforderungen erfüllen.
h2. 7. Integrationsveroeffentlichung & Enablement
Veroeffentlichen Sie die Integrations-Capability, damit Teams sie finden, bewerten, Zugriff beantragen, das Onboarding abschliessen, wiederverwenden und Support erhalten koennen.
h3. Station questions
* Veröffentlichen Sie Capability-Informationen in passenden Katalogen, Portalen, Gateways oder Umgebungen, damit mehrere Nutzer die Capability wiederverwenden können.
* Dokumentieren Sie, wie die Nutzer die API finden und nutzen, einschließlich Onboarding-Prozesse und Registrierung.
* Stellen Sie sicher, dass die Sicherheitsmodelle, die Gateway-Konfiguration und die rechtlichen Bestimmungen für die Nutzer klar und verständlich sind.
* Veröffentlichen Sie Ownership, Dokumentation, Onboarding, Supportkontakte, Serviceerwartungen, Lifecycle-Status und Zugriffspfade.
* Wiederverwendbare Capabilities erzeugen nur dann Wert, wenn Nutzer sie finden, den Schnittstellenvertrag und die Serviceerwartungen verstehen, Zugriff beantragen und Support sowie Lifecycle-Ownership kennen.
h3. Other related resources
* *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.
* *Vorlage für eine Dienstleistungsvereinbarung*: Ein anpassbares Vertragsformat, das Erwartungen, SLAs, Verantwortlichkeiten und Zugriffsbedingungen für die API-Nutzung definiert.
h2. 8. Integrationsmonitoring & Verbesserung
Überwachen Sie Integrationszuverlässigkeit, Wiederverwendung, Incidents, Performance, Nutzerergebnisse und Verbesserungsbedarf.
h3. Station questions
* Definieren Sie Metriken für Nutzung, Zuverlässigkeit, Datenqualität, Kosten, Adoption und Nutzerwert.
* Analysieren Sie API-Nutzungsmetriken und integrieren Sie Benutzerfeedback in API-Iterationen.
* Machen Sie es sich zur Gewohnheit, die Messwerte zu überprüfen und kontinuierliche Verbesserungsmaßnahmen zu planen.
* Nutzen Sie Metriken, Analytics und Feedbackpraktiken, um die Capability kontinuierlich zu verbessern.
* Capabilities brauchen kontinuierliches Feedback, um zuverlässig, wertvoll, kosteneffizient und wiederverwendbar zu bleiben, wenn sich Nutzer, Systeme, Daten und Plattformen ändern.
h3. Other related resources
* *API-Metriken und -Analysen*: Eine Ressource zum Definieren, Sammeln und Analysieren von API-Leistungs- und -Nutzungsdaten, um technische KPIs mit den Geschäftsergebnissen in Einklang zu bringen.
* *Strategien für das Engagement der API-Gemeinschaft*: Ein Leitfaden für die Förderung der API-Annahme durch die Pflege von Gemeinschaften durch Inhalte, Support-Kanäle, Feedback-Schleifen und Strategien für soziales Engagement.