Anfragen und Antworten

Format von Anfragen und Antworten der REST-API von vynst (inwendo ERP), Header und Hüllen-Objekte.

Die API spricht JSON. Anfragen mit Body schicken content-type: application/json, Antworten kommen als application/json. Nur Datei-Uploads nutzen multipart/form-data.

Pfade und Methoden

Methode	Bedeutung
`GET`	Liste oder einzelnen Eintrag lesen
`POST`	Eintrag anlegen oder eine Aktion auslösen
`PUT`	Eintrag mit allen gesendeten Feldern ändern
`PATCH`	nur die gesendeten Felder ändern
`DELETE`	Eintrag löschen oder archivieren

Hülle im Request-Body

Beim Anlegen und Ändern steckt das Objekt in einer Hülle mit dem Namen der Ressource. Eine neue Person sieht so aus:

{
  "crmperson": {
    "first_name": "Lena",
    "last_name": "Hartmann"
  }
}

Welche Hülle ein Endpunkt erwartet, zeigt der Abschnitt Request-Body auf jeder API-Seite. Die Codebeispiele bauen sie schon richtig auf.

Feldnamen

Die API nutzt snake_case. Wer lieber mit camelCase arbeitet, setzt diese Header:

Header	Wirkung
`x-iw-convert-to-camel-case: 1`	Feldnamen im Body von `camelCase` nach `snake_case` übersetzen
`x-iw-convert-object-to-id: feld,feld`	diese Felder auf die innere ID reduzieren, wenn ein Objekt kommt
`x-iw-convert-string-to-date-time: feld,feld`	diese Felder als Datum lesen, auch wenn sie als Text oder Zeitstempel kommen

Client-Kennung

Jeder Endpunkt nimmt optional iw-build-id und iw-package-id an. Eigene Apps können damit Build und Paket mitschicken, das hilft beim Support. Auf den API-Seiten sind die beiden Parameter deshalb nicht einzeln aufgeführt.

Zeitangaben

Datum und Uhrzeit kommen im Format ISO 8601 mit Zeitzone, zum Beispiel 2026-10-15T09:30:00+02:00.