API-Standards

Konzept

Gemeinsame Standards sollen Integrationen vorhersehbar machen, ohne fachliche Unterschiede künstlich zu vereinheitlichen.

Grundsätze

• Ressourcen und Aktionen verwenden konsistente Begriffe.
• Schnittstellen besitzen eine nachvollziehbare Version.
• Eingaben werden an der Dienstgrenze geprüft.
• Antworten unterscheiden Erfolg, fachliche Ablehnung und technischen Fehler.
• Zeit-, Identitäts- und Referenzfelder werden eindeutig definiert.
• Wiederholte Anfragen dürfen keine unbeabsichtigten Mehrfachwirkungen auslösen.
• Änderungen an Verträgen werden dokumentiert.

Dokumentation vor Freigabe

Eine veröffentlichte API benötigt Zweck, Authentifizierungsanforderungen, Berechtigungen, Ein- und Ausgaben, Fehlerfälle, Versionsregeln und neutrale Beispiele.

Konkrete Feldnamen und Formate sind noch nicht als gemeinsamer produktiver Standard freigegeben.