Integrations-API

Umstieg von CMWS

Die CMWS-Schnittstelle des alten DDM arbeitet weiter — nur die Adresse ändert sich.
Nur für bestehende Anbindungen. CMWS bleibt, damit Anbindungen an das alte DDM weiterlaufen. Eine neue Anbindung nutzt die Integrations-API (/api/ext/v1): Schlüssel im Header statt in der Adresse, ids, die sich nie ändern, ein Änderungsfeed, Gruppen, Märkte und Zugriffe — und jede neue Funktion. CMWS bekommt keine mehr.

Anbindungen an die CMWS-Schnittstelle des alten Document Distribution Manager (<alte Instanz>/cmws/v1/) arbeiten in DDM weiter. Beim Umzug Ihrer Organisation kommen Ihre CMWS-Schlüssel, die ids Ihrer Datensätze und die origin_ids, die Ihre Systeme ihnen gegeben haben, mit. Ändern Sie die Adresse, sonst nichts:

vorher    https://ddm.kunde.de/cmws/v1/file?apikey=546b9be5a616b5c629be546173&origin_id=PIM-4711
nachher   https://<Ihr DDM>/api/cmws/v1/file?apikey=546b9be5a616b5c629be546173&origin_id=PIM-4711

Zeigt Ihr alter Hostname auf das neue DDM, antwortet auch der alte Pfad /cmws/v1/ — dann ändert sich nicht einmal das.

Aufrufe, Felder, Fehlercodes (-1001, -1002, -1003) und das Listenformat (items, current, item_count, prev, next) sind die der CMWS-Dokumentation. Ids und Schalter kommen als Zeichenketten, Zeiten als ISO 8601 (2026-10-29T08:00:00.000Z); Y-m-d H:i:s wird weiter angenommen, als UTC.

Was CMWS in DDM ist

CMWSDDM
FileEin Dokument, eingespielt über die Push-Quelle des Schlüssels — origin_id ist dort seine Referenz.
CategoryEine Kategorie. Eine unter mehreren Eltern ist je Elternteil eine Kategorie, mit derselben id.
TerritoryEine Gruppe, benannt <Typ>: <Titel>.
TerritoryTypeEin Name: Umbenennen benennt die Gruppen seiner Territorien um.
LocaleDer Markt ihres Landes. Mehrere Locales eines Landes teilen ihn.
territory_ids einer Kategorieread für die Gruppen der Territorien — und none für ein nicht genanntes Territorium, das sonst von oben erben würde.
users einer Datei (user_only)read für jede Person, und none für jede Gruppe, die die Kategorien der Datei hereinlassen würden.
published_status, publish_for_periodArchiviert oder nicht; der Verfügbarkeits-Zeitraum des Dokuments.
is_highlight, is_highlight_for_periodDie Hervorhebung; ihr Zeitraum.
generate_watermarkDas Wasserzeichen: die E-Mail-Adresse jedes Lesers auf jeder Seite, die er bekommt. Nur PDFs und Office-Dateien.

Jeder Aufruf handelt in DDM als die Person des Schlüssels, mit deren Rechten, und steht unter dem Namen des Schlüssels im Protokoll.

Was sich anders verhält

  • Angenommen und zurückgegeben, ohne Wirkung: published_for_form_factor, orientation, generate_thumbnail und ein thumbnail-Teil — die Vorschau entsteht aus der Datei — sowie published einer Kategorie: DDM kennt keine unveröffentlichten Kategorien.
  • Eine auf Personen beschränkte Datei bleibt für die Gruppen beschränkt, die sie beim Senden erreichen. Bekommt eine Gruppe später Zugriff auf ihre Kategorie, sieht sie die Datei auch.
  • Eine Kategorie löschen schiebt die Kategorien darunter nach oben und legt Dokumente, die nur dort lagen, in CMWS: without category; in DDM liegt jedes Dokument in einer Kategorie.
  • Ein Territorium löschen löscht seine Gruppe, mit ihren Mitgliedern und jeder Kategorie, die sie öffnete.
  • Eine Locale löschen entfernt ihren Markt nur, wenn keine andere Locale ihn teilt und er nicht der Standard ist — mit jedem Titel in ihm.
  • Unveröffentlichte Dateien (published_status 0) werden archiviert; die Aufbewahrungsregeln der Organisation gelten für sie.
  • Ist Erst nach Freigabe verteilen eingeschaltet, liest eine eingespielte Datei published_status "0", bis sie freigegeben ist.
  • origin_descriptor nennt Ihren Schlüssel nur bei Ihren eigenen Datensätzen; bei denen eines anderen Schlüssels ist er null.
  • /ids und /originids listen die ganze Organisation, wie bisher; Datensätze, die nie eine CMWS-id hatten, werden nach der höchsten alten nummeriert.
  • CMWS braucht die Integrations-API im Tarif, wie API-Schlüssel.

Der nächste Schritt

Ihre alten Schlüssel stehen unter Einstellungen › API-Zugang als Alter CMWS-Schlüssel. Sie stehen in der Adresse und damit in vielen Protokollen; ersetzen Sie einen dort durch einen neuen Schlüssel — Push-Quelle und handelnde Person bleiben — und senden Sie den neuen in ?apikey=. Die Integrations-API kann alles, was CMWS kann, und mehr: mit dem Schlüssel im Header, ids, die sich nie ändern, und einem Änderungsfeed.