Was bedeutet API-Vertrag?
Der Vertrag beschreibt mehr als eine technische Adresse. Er nennt Funktionen, erforderliche Angaben, Antwortformate und mögliche Fehler. Auch die Bedeutung von Feldern und Regeln für wiederholte Anfragen gehören dazu.
Eine maschinenlesbare Beschreibung, etwa mit OpenAPI, erleichtert Dokumentation und Prüfungen. Fachliche Zusagen, die sich darin nicht vollständig ausdrücken lassen, müssen zusätzlich verständlich dokumentiert werden.
So sieht das in der Praxis aus
Beispiel: Der Vertrag legt fest, dass eine Auftragserstellung eine Kundennummer und mindestens eine Position benötigt.
Häufige Fragen
Ist ein API-Vertrag dasselbe wie ein juristischer Vertrag?
Hier bezeichnet der Begriff die technische und fachliche Schnittstellenvereinbarung. Rechtliche Nutzungsbedingungen oder Vereinbarungen zum Datenschutz sind davon getrennt zu betrachten.
Welche Fehlerfälle gehören in den Vertrag?
Zum Beispiel fehlende Pflichtangaben, unzulässige Zugriffe und vorübergehende Ausfälle. Nutzer müssen erkennen können, ob sie Daten korrigieren oder später erneut anfragen sollen.
Wie lässt sich prüfen, ob beide Seiten den Vertrag einhalten?
Mit abgestimmten Beispielen und automatisierten Vertragstests. Diese prüfen vereinbarte Anfragen und Antworten, decken aber nur die ausdrücklich berücksichtigten Fälle ab.