Integration API

OpenAPI

The machine-readable description of the API – for Postman, Insomnia and client generators.

The whole API is described as OpenAPI 3.1: every endpoint, parameter, field and error.

For your DDM: https://<your CMS address>/api/ext/v1/openapi.json – no key needed. Settings › API access links to it.
Download: ext-v1.openapi.json, the same description with ddm.example.com as the server.

The description is generated from the same rules the API checks requests against, so it always matches what the API accepts.

Postman and Insomnia

Import › Link or File, and give the address or the file. Then set the authorisation of the collection to Bearer Token with your key.

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 knows many languages: python, java, csharp, go, php and more.

Reference: sync manifest

GET /sync – everything a key can see in one list, to find what was deleted.

Changelog

Changes to the integration API.