Schnittstellenbeschreibung

Eine Schnittstellenbeschreibung dokumentiert, wie Systeme oder Organisationen Daten austauschen und zusammenarbeiten sollen. Sie umfasst mehr als einen technischen Endpunkt und muss auch Bedeutung, Ablauf sowie Fehlerbehandlung klären.
Worauf es bei der Arbeit ankommt
Beschreiben Sie Datenfelder, Formate, Zugriffsregeln und typische Abläufe. Ergänzen Sie Volumen, Aktualisierung, Rückmeldungen und Versionswechsel. Prüfen Sie einen vollständigen Geschäftsvorfall einschließlich Fehlerfall, bevor die Integration als einfach oder bereits erfüllt eingeordnet wird.
Was bedeutet das für Ihre Ausschreibung?
In Ausschreibungen beeinflusst sie Integrationsaufwand, Testbarkeit und spätere Betriebskosten. Ein allgemeiner Hinweis auf eine vorhandene Programmierschnittstelle belegt nicht, dass alle benötigten Fachvorgänge unterstützt werden.
Drei konkrete Prüfpunkte
- Welche Fachaktion ist möglich?
- Wie werden Fehler zurückgemeldet?
- Welche Änderungen bleiben kompatibel?
Eine typische Verwechslung vermeiden
Zwei Systeme können dasselbe Dateiformat lesen und trotzdem unterschiedliche Bedeutungen für ein entscheidendes Feld verwenden.
