Die MACH ProForms GmbH setzt bei der Produktstrategie auf den API-First Ansatz. D.h., dass perspektivisch alle Funktionen über eine API erreichbar und ansteuerbar sind.

Übersicht der APIs

Aktuelle APIs

• Die Dokumentation zum Anlegen von „API-Keys“ für Nutzung der Schnittstellen
• Die Dokumentation der „Server-Information-API“
• Die Dokumentation der „Search-API“
• Die Dokumentation der „Release-API“
• Die Dokumentation der „Submission-API“
• Die Dokumentation der „Error-API“

Veraltete APIs

• Die Dokumentation der „Search-API-Metaform“
• Die Dokumentation der „Massenverarbeitung von Formular-Eingängen-API“
• Die Dokumentation der „CMS-Schnittstelle“
• Die Dokumentation der „PDF Structure-API“

Versionierung

Grundsätzlich legen wir unsere APIs für eine möglichst lange Betriebsphase aus und streben Versionskompatibilität an. Im Nachfolgenden finden Sie unsere Vorgehensweise im Detail.

Wir behalten (soweit technisch möglich) immer zwei Versionen online. Sobald eine neue Version hinzukommt, wird die älteste Version mit einem zeitlichen Horizont von mindestens 6 Monaten abgekündigt. Nach dieser Frist ist die Version und alle ihre Minor-Versionen nicht mehr erreichbar.

Eine neue Major-Version (1.x) kann Änderungen beinhalten, welche nicht mehr abwärtskompatibel sein müssen (Abhängig von Ihrer Implementierung). Dies sind z.B.:

• Authentifizierungsmethoden
• Umbenennung und Löschung von Endpunkten
• Löschung von HTTP-Methoden an vorhandenen Endpunkten
• Umbenennung und Löschung von Parametern
• Restrukturierung des Response-Objekt

Eine neue Minor-Version (x.1) ist per Definition abwärtskompatibel zur Major-Version. Dabei können sich aber folgende Dinge ändern:

• Zusätzliche Endpunkte
• Zusätzliche HTTP-Methoden an Endpunkten
• Weitere (optionale) Parameter für eine Abfrage (z.B. Filterfunktion)
• Erweitertes Response-Objekt

Versionshistorie

Zu jeder API finden Sie als Unterknoten jeweils den "Release-Notes"-Artikel. Beispiel Submission-API.