Hilfe
Fragen, Änderungen, Werkzeuge
Wohin mit einer Frage, und woran du dich beim Bauen halten kannst.
Wenn etwas nicht geht
- Technischer KontaktSchick die
request_idaus der Fehlerantwort mit — damit ist der Aufruf in unseren Protokollen auffindbar. - Hilfe-CenterAnleitungen zum Produkt: Objekte anlegen, Portale verbinden, Preise pflegen.
- Client generierenDie OpenAPI-Datei taugt als Eingabe für die üblichen Generatoren — ein handgeschriebener Client ist unnötig.
Versionierung
Eine API ist ein Versprechen. Diese vier Punkte gelten für v1:
- Die Version steht im Pfad. Eine brechende Änderung bekommt
/v2;/v1läuft daneben weiter. - Innerhalb von v1 kommen nur Felder hinzu. Bestehende Felder werden nicht umbenannt und ändern ihre Bedeutung nicht.
- Wird eine Version abgekündigt, nennen wir ein Datum mit mindestens zwölf Monaten Frist und melden uns bei jedem Betrieb mit einem aktiven Zugang.
- Änderungen stehen in der OpenAPI-Datei und in dieser Seite. Es gibt keine stille Änderung an einem Feld.