Bevor Sie eine Integration erstellen: Prüfen Sie die API-Änderungsrichtlinien einer App

Beginnen Sie mit dem kritischen Workflow

Eine API-Integration verbindet Anwendungen über ihre APIs, damit sie Daten und Funktionen austauschen können. Diese allgemeine Definition stammt von OpenText: https://www.opentext.com/what-is-api-integration. Die folgenden Punkte sind ein allgemeiner Prüfrahmen, keine Aussagen über die Richtlinien einer bestimmten App. Solche Richtlinien müssen Sie in den offiziellen Unterlagen des jeweiligen Anbieters prüfen.

Beschreiben Sie zuerst, was die Integration im Betrieb leisten muss. Workato empfiehlt bei der Bewertung einer Integrationsplattform unter anderem, die benötigten Daten und Anwendungen zu berücksichtigen: https://www.workato.com/the-connector/evaluating-an-integration-platform-heres-what-you-need-to-know/. Für Ihren eigenen Prüfplan können Sie daraus konkrete Fragen zu Abläufen und Folgen eines Fehlers ableiten.

• Welche Datensätze müssen gelesen, erstellt, aktualisiert oder verknüpft werden?
• Welche Aktionen sollen die Integration auslösen, und in welcher Reihenfolge?
• Welche Schritte müssen gemeinsam erfolgreich sein?
• Was wären die betrieblichen Folgen, wenn ein Vorgang ausfällt, verspätet ausgeführt wird oder unvollständige Daten liefert?
• Wer wartet die Verbindung und untersucht Probleme?

Prüfen Sie die offiziellen Lebenszyklusangaben

Suchen Sie in der offiziellen API-Dokumentation, den Entwicklerleitfäden, Versionshinweisen, Änderungsprotokollen und Supportmaterialien der jeweiligen Anwendung. Prüfen Sie, ob diese Unterlagen Aussagen zu Kompatibilität, inkompatiblen Änderungen, Abkündigungen, Supportzeiträumen und der Ankündigung von Änderungen enthalten.

Leiten Sie keine Zusage allein aus einer Versionsnummer oder einer heute erfolgreichen Anfrage ab. Die bereitgestellten Quellen belegen keine konkreten Lebenszyklusregeln für eine bestimmte Business-App. Wenn eine Angabe fehlt oder unklar ist, kennzeichnen Sie sie in Ihrer Bewertung als offene Frage.

• Erklärt der Anbieter, was als inkompatible Änderung gilt?
• Wie werden veraltete Endpunkte oder Felder gekennzeichnet?
• Wird ein Support- oder Übergangszeitraum genannt, und für welche Schnittstellen gilt er?
• Wo werden Änderungen angekündigt, und kann Ihr Team diesen Kanal überwachen?
• Sind die Aussagen datiert und dem benötigten Produkt- oder API-Bereich zugeordnet?

Vergleichen Sie Dokumentation und Tests

Gleichen Sie die offizielle API-Referenz mit den Vorgängen ab, die Ihr Workflow benötigt. Beispiele können beim Verständnis helfen, ersetzen aber keine Klärung wichtiger Anforderungen, die in den Unterlagen nicht beantwortet werden. Notieren Sie Lücken und stellen Sie dem Anbieter oder Verantwortlichen konkrete Fragen.

Prüfen Sie nicht nur, ob eine einzelne Anfrage funktioniert. Legen Sie anhand der Dokumentation und Ihrer Anforderungen fest, welches Verhalten Sie testen müssen. Bewahren Sie repräsentative Anfragen, Antworten und erwartete Ergebnisse als Regressionstests auf; verwenden Sie dabei keine sensiblen Produktionsdaten.

• Prüfen Sie, welche Kennungen und Pflichtfelder Ihre Integration benötigt.
• Testen Sie erfolgreiche und abgelehnte Vorgänge sowie die für Ihren Ablauf relevanten fehlenden oder unerwarteten Werte.
• Kontrollieren Sie, ob Antworten die erwartete Struktur haben und wie Ihre Integration auf Abweichungen reagiert.
• Fragen Sie, ob eine Sandbox oder Testinstanz verfügbar ist und welche Vorgänge sie abbildet.
• Klären Sie, wie Testdaten getrennt, zurückgesetzt oder entfernt werden können.

Planen Sie Überwachung und Zuständigkeit

Dokumentieren Sie, von welchen Anwendungen und API-Bereichen kritische Abläufe abhängen und wo die dafür maßgebliche Dokumentation liegt. Vereinbaren Sie, wer Änderungsmitteilungen prüft, Tests erneut ausführt und bei einem Fehler reagiert.

Richten Sie eine für Ihre Umgebung geeignete Überwachung ein, damit fehlgeschlagene oder unvollständige Abläufe sichtbar werden. Wenn Sie eine Anwendung selbst hosten, behandeln Sie Hosting und API-Lebenszyklus als getrennte Themen: Infrastrukturleistungen belegen keine API-Kompatibilität und ersetzen weder Ihre Integrationswartung noch Entscheidungen zu Daten und Zugriff.

• Benennen Sie eine zuständige Person für Änderungsmitteilungen.
• Halten Sie geschäftliche Auswirkungen und Abhängigkeiten der Integration fest.
• Legen Sie fest, wer Fehler untersucht und wie ein Workflow angehalten oder wiederhergestellt wird.
• Führen Sie Tests für kritische Abläufe erneut aus, wenn sich relevantes API-Verhalten geändert haben könnte.

Vergleichen Sie Kandidaten mit einem Entscheidungsbogen

Verwenden Sie für jede Anwendung dieselben Fragen und kennzeichnen Sie Antworten als dokumentiert, getestet, vom Anbieter bestätigt, unbekannt oder nicht zutreffend. So bleiben belegte Angaben von Annahmen unterscheidbar.

Es gibt keine allgemeine Punktzahl, die eine API für jeden Einsatz sicher macht. Legen Sie Ihre Mindestanforderungen nach den Folgen eines Ausfalls und der Fähigkeit Ihres Teams fest, die Integration zu warten. Halten Sie offene Fragen fest und entscheiden Sie, ob die verbleibende Unsicherheit für den jeweiligen Workflow akzeptabel ist.

• Welche Datensätze und Abläufe müssen funktionieren?
• Wo beschreibt der Anbieter Kompatibilität, Abkündigungen und Änderungsmitteilungen?
• Decken die Unterlagen genau die benötigten Vorgänge und Felder ab?
• Können Sie kritisches Verhalten sicher testen?
• Kann Ihr Team Mitteilungen überwachen und auf Fehler reagieren?
• Welche Punkte müssen vor der Auswahl noch bestätigt werden?

Welche Rolle Managed Self-Hosting spielt

Für Teams, die eine selbst gehostete Business-Anwendung auswählen, sind Hosting und API-Eignung getrennte Entscheidungen. Airbip bietet die verwaltete Bereitstellung von Anwendungen aus seinem öffentlichen Katalog als Docker-Workloads auf Airbip-Cloud-Servern. Der Service automatisiert Routing und TLS-Zertifikate, umfasst DNS-Prüfungen, die Verwaltung des Service-Lebenszyklus sowie konfigurierbare tägliche, wöchentliche und monatliche Backups. Kunden können eine Airbip-Subdomain oder eine kompatible eigene Domain nutzen.

Diese Infrastrukturleistungen belegen weder die API-Änderungsrichtlinien einer Anwendung noch, dass eine bestimmte Integration weiterhin funktioniert. Prüfen Sie die offizielle Dokumentation und testen Sie Ihre relevanten Workflows separat. Legen Sie außerdem fest, wie Ihr Team Daten, Zugangsdaten, Berechtigungen und die Wartung der Integration verwaltet. Aktuelle Tarife und genaue Geschäftsbedingungen finden Sie auf der aktuellen Airbip-Website.