DDM HilfeÜberblick
Die eingebauten externen Quellen holen Dokumente aus SharePoint, Google Drive, OneDrive, von einem FTP-Server oder über eine HTTP-Schnittstelle. Manche Systeme haben keinen eingebauten Konnektor: ein PIM, ein ERP, ein DMS, Ihre eigene Anwendung. Dafür gibt es die Integrations-API. Das ist eine HTTP/JSON-Schnittstelle, die Ihre Entwickler oder die Entwickler des anderen Systems selbst aufrufen.
Sie funktioniert in zwei Richtungen:
| Richtung | Was ein anderes System tut | Typischer Einsatz |
|---|---|---|
| Einspielen | Schickt Dokumente an DDM und legt sie mit ihren Kategorien, Schlagwörtern und Titeln an, ändert und löscht sie | Ein PIM schickt nach jeder Freigabe jedes Datenblatt als PDF |
| Abrufen | Liest Dokumente, Kategorien und Dateien aus DDM | Ein Skript kopiert jede Nacht alle freigegebenen Preislisten auf die Website |
/api/cmws/v1 mit Ihren alten Schlüsseln weiter – siehe Umstieg von CMWS.Das Wichtigste
- Adresse:
https://<Ihre CMS-Adresse>/api/ext/v1. Unter Einstellungen › API-Zugang steht die genaue Adresse, mit einer Schaltfläche zum Kopieren. - Format: JSON. Dateien werden als
multipart/form-datahochgeladen. - Anmeldung: mit einem API-Schlüssel, gesendet als
Authorization: Bearer ddm_…. Siehe Authentifizierung. - Rechte: Ein Schlüssel handelt als eine Person Ihrer Organisation und hat genau deren Rechte. Er sieht und ändert genau das, was diese Person im CMS sehen und ändern kann.
- Referenz: Die vollständige Beschreibung ist ein OpenAPI-Dokument. Sie können es in Postman, Insomnia oder einen Client-Generator importieren.
Eine erste Anfrage
curl https://ddm.example.com/api/ext/v1/documents?limit=5 \
-H "Authorization: Bearer $DDM_API_KEY"
const response = await fetch('https://ddm.example.com/api/ext/v1/documents?limit=5', {
headers: { Authorization: `Bearer ${process.env.DDM_API_KEY}` }
})
const { data, nextCursor } = await response.json()
import os, requests
response = requests.get(
"https://ddm.example.com/api/ext/v1/documents",
params={"limit": 5},
headers={"Authorization": f"Bearer {os.environ['DDM_API_KEY']}"},
)
page = response.json()
$headers = @{ Authorization = "Bearer $env:DDM_API_KEY" }
Invoke-RestMethod -Uri "https://ddm.example.com/api/ext/v1/documents?limit=5" -Headers $headers
Konnektor oder API?
| Eingebauter Konnektor | Integrations-API | |
|---|---|---|
| Wer arbeitet | DDM holt nach Zeitplan | Das andere System ruft DDM auf |
| Einrichtung | Nur Einstellungen | Jemand schreibt die Aufrufe |
| Wann eine Änderung ankommt | Beim nächsten Abgleich | Sobald das andere System sie schickt |
| Inhalte aus DDM abrufen | – | Ja |
Wenn DDM für Ihr System schon einen Konnektor hat, nehmen Sie den Konnektor. Die API ist für Systeme ohne Konnektor da, für Änderungen, die sofort ankommen müssen, und für Inhalte, die von DDM in ein anderes System sollen.
Stabilität
Innerhalb von v1 kommt nur Neues hinzu: neue Endpunkte, neue optionale Felder, neue Felder in Antworten. Bestehende Felder behalten Namen und Bedeutung. Ein Programm sollte Felder ignorieren, die es nicht kennt. Eine inkompatible Änderung käme als v2, die parallel zu v1 läuft. Alle Änderungen stehen im Änderungsprotokoll.