Versionierung
Die Händler-API und ihre Dokumente haben die Version 1, und innerhalb von v1 wachsen sie nur. Eine gegen v1 geschriebene Integration funktioniert weiter.
Pfade, Feldnamen, Fehlercodes, Header-Namen und Codebeispiele bleiben englisch: Sie sind der Vertrag.
Was sich innerhalb von v1 ändern darf
- Ein neues optionales Feld in einer Antwort, einer Anfrage oder dem Bestelldokument.
- Eine neue Route, ein neuer Fehlercode, ein neues Webhook-Ereignis oder ein neuer Wert in einer Liste erlaubter Werte.
- Ein neues Signaturschema neben
v1=inCutOptim-Signature; Empfänger ignorieren Schemata, die sie nicht kennen.
Was sich innerhalb von v1 nie ändert
- Kein Feld verschwindet, wird umbenannt oder ändert seine Bedeutung.
- Keine Route ändert ihren Pfad, ihren Schlüssel oder die Form ihrer Antwort.
- Ein Fehlercode behält seine Bedeutung.
Schreiben Sie einen toleranten Leser
Ignorieren Sie Felder, die Sie nicht kennen, behandeln Sie einen unbekannten Fehlercode anhand seines HTTP-Status und nehmen Sie einen Webhook-Ereignistyp, den Sie nicht abonniert haben, mit einem 2xx an. Die schemaVersion des Bestelldokuments und jedes Webhook-Bodys ist 1.
Eine inkompatible Änderung
Eine inkompatible Änderung wäre ein neues Dokument (order.v2) oder ein neuer Pfad (/cfg/v2) neben v1, nie eine Umschreibung von v1. Sie würde im Änderungsprotokoll angekündigt.
Eine Schaltfläche "Ausprobieren" gibt es hier mit Absicht nicht: Der geheime Schlüssel gehört auf Ihren Server, nie in einen Browser. Der Demo-Shop zeigt Einbettung und Bestellübergabe von Anfang bis Ende.
RechtlichesKonfigurator-Bedingungen (EN) ·Auftragsverarbeitungsvertrag (EN) ·Datenschutzhinweis für Käufer ·Drittanbieter-Lizenzen (EN)