Integrations-API

OpenAPI

Die maschinenlesbare Beschreibung der API – für Postman, Insomnia und Client-Generatoren.

Die ganze API ist als OpenAPI 3.1 beschrieben: jeder Endpunkt, Parameter, jedes Feld und jeder Fehler.

Für Ihr DDM: https://<Ihre CMS-Adresse>/api/ext/v1/openapi.json – ohne Schlüssel. Einstellungen › API-Zugang verlinkt sie.
Download: ext-v1.openapi.json, dieselbe Beschreibung mit ddm.example.com als Server.

Die Beschreibung wird aus denselben Regeln erzeugt, mit denen die API Anfragen prüft. Sie passt also immer zu dem, was die API annimmt.

Postman und Insomnia

Import › Link oder Datei, und die Adresse oder die Datei angeben. Dann die Autorisierung der Sammlung auf Bearer Token mit Ihrem Schlüssel setzen.

Einen Client erzeugen

npx openapi-typescript https://ddm.example.com/api/ext/v1/openapi.json -o ddm-api.d.ts

npx @openapitools/openapi-generator-cli generate \
  -i https://ddm.example.com/api/ext/v1/openapi.json \
  -g python -o ddm-client

openapi-generator kennt viele Sprachen: python, java, csharp, go, php und mehr.

Referenz: Abgleich-Manifest

GET /sync – alles, was ein Schlüssel sieht, in einer Liste, um Gelöschtes zu finden.

Änderungsprotokoll

Änderungen an der Integrations-API.