Blog Worauf Sie bei einer PDM-API achten sollten: Käuferleitfaden zur Integrationsreife
Worauf Sie bei einer PDM-API achten sollten: Käuferleitfaden zur Integrationsreife
Bewerten Sie eine PDM-API für sichere, zuverlässige ERP- und Business-System-Integrationen: Datenhoheit, Events, Tests, Fehlerbehandlung und API-Änderungsmanagement.
Stellen Sie sich diesen Integrationstest vor: Die Konstruktion gibt Revision B einer Baugruppe frei, aber das ERP lehnt die Stückliste ab, weil einem untergeordneten Teil die Mengeneinheit fehlt. Während eines Wiederholungsversuchs trifft die Freigabebenachrichtigung erneut ein. Kann die Integration die abgelehnte Aktualisierung kennzeichnen, eine doppelte Verarbeitung vermeiden und dem Einkauf anzeigen, dass Revision B das ERP nicht erreicht hat?
Eine PDM-API kann Konstruktionsdatensätze mit ERP, Einkauf, Qualitätssicherung oder internen Tools verbinden. Ob sie im Tagesgeschäft funktioniert, hängt von den Datensätzen ab, die sie offenlegt, von den Zugriffen, die sie erlaubt, und davon, wie die Integration mit Änderungen und Fehlern umgeht. Eine Datei herunterzuladen beweist nur einen kleinen Teil davon.
Dieser Leitfaden behandelt fünf Bereiche, die vor dem Einsatz einer PDM-API für geschäftskritische Konstruktionsdaten bewertet werden sollten. Zur verwandten Frage, was aus dem PDM in das ERP übergehen sollte, siehe PDM–ERP-Integration: Wie Konstruktionsdaten in den Einkauf fließen.
Ein API-Zugriff löst unklare Konstruktionsdaten nicht
Eine API stellt Daten und Operationen bereit; Ihr Team muss sich dennoch auf die Übergaberegeln einigen. Wenn Teilenummern inkonsistent sind, Revisionen von jedem Team unterschiedlich interpretiert werden oder niemand sich einig ist, wann eine Konstruktion freigegeben ist, kann die Automatisierung diese Probleme nur schneller verbreiten.
Dokumentieren Sie zu Beginn die Konstruktionsübergabe in klarer Sprache:
Welches System ist Eigentümer der freigegebenen Teildefinition und Revision?
Welches Ereignis macht einen Datensatz für Einkauf oder Fertigung bereit?
Welche Felder darf das ERP aktualisieren, und welche müssen unter Kontrolle der Konstruktion bleiben?
Was passiert, wenn ein Teil abgelöst, obsolet oder bei der Validierung abgelehnt wird?
Nutzen Sie diese Antworten, um festzulegen, was die Integration lesen und ändern darf.
1. Berechtigungen und Sicherheit
Eine Integration sollte nur den Zugriff erhalten, den sie benötigt. Ein Dienst zur Einkaufssynchronisation muss zum Beispiel freigegebene Teile und Zeichnungen lesen können, aber keine Entwurfs-CAD-Daten ändern oder eine Konstruktionsänderung freigeben dürfen. Dasselbe Prinzip minimaler Rechte gilt für die rollenbasierte Zugriffskontrolle in einem PDM-System.
Für die Sicherheitsüberprüfung klären Sie:
Welche Authentifizierungsmethoden werden für Server-zu-Server-Integrationen unterstützt?
Lässt sich der Zugriff nach Workspace, Projekt, Objekttyp, Lebenszyklusstatus oder Aktion einschränken?
Kann ein Dienstkonto freigegebene Datensätze lesen, ohne nicht verwandte Projekte zu sehen?
Sind Credentials eingegrenzt, widerrufbar, auditierbar und werden sie sicher ungültig, wenn ein Nutzer ausscheidet oder ein Credential abläuft?
Werden API-Aktionen mit Akteur, Zeitstempel und betroffenem Objekt protokolliert?
Autorisierung muss auf Objekt- und Eigenschaftsebene geprüft werden, nicht nur bei der ersten Authentifizierung eines Nutzers. OWASP identifiziert Broken Object Level Authorization und mangelhaftes API-Inventory-Management unter den häufigen API-Sicherheitsrisiken. Die OWASP API Security Top 10 sind eine nützliche Basis für eine Sicherheitsüberprüfung. Für OAuth-basierten Zugriff dokumentiert RFC 9700 die aktuellen Sicherheitsempfehlungen.
Testen Sie die Grenze mit einem eingeschränkten Credential. Es sollte den vorgesehenen freigegebenen Datensatz abrufen, während Anfragen zu nicht verwandten Projekten oder unberechtigten Änderungen fehlschlagen sollten.
2. Datenobjekte und das führende System
Für eine ERP-Übergabe reicht es nicht, eine CAD-Datei herunterzuladen. Das Zielsystem muss das Teil, die zugehörige Revision und die dazugehörige Stückliste bzw. Zeichnung identifizieren können. Prüfen Sie das Datenmodell der API gegen die Datensätze, die Ihr Workflow tatsächlich verwendet:
Objekt oder Feld
Frage an den Käufer
Warum es wichtig ist
Teil oder Artikel
Gibt es eine stabile Kennung, die über Revisionen hinweg aussagekräftig bleibt?
ERP und Einkauf müssen den korrekten operativen Datensatz identifizieren.
Revision und Lebenszyklusstatus
Kann die Integration die Zustände Entwurf, geprüft, freigegeben, abgelöst und obsolet unterscheiden?
Nachgelagerte Systeme sollten laufende Arbeiten nicht als freigegebene Konstruktionsdaten behandeln.
Stückliste (BOM)
Kann die Integration die vereinbarte Stücklistenstruktur, Mengen und Mengeneinheiten abrufen?
Teams brauchen eine klare Basis, um zu entscheiden, welche Stückliste in einen operativen Workflow gehört.
Dateien und Zeichnungen
Kann die API kontrollierte Verweise auf die freigegebene Zeichnung oder Spezifikation liefern?
Einkauf und Lieferanten brauchen einen nachvollziehbaren Weg zum anwendbaren Dokument.
Kann ein geänderter oder abgelöster Datensatz mit dem Grund und dem Freigabekontext verknüpft werden?
Der Einkauf muss verstehen, wann eine freigegebene Änderung bestehende Bestellungen oder Bestände betrifft.
Ziel ist nicht, jedes PDM-Feld im ERP zu duplizieren. Legen Sie für jedes geteilte Feld ein führendes System fest, bevor Sie es mappen. Zum Beispiel kann die Konstruktion die freigegebene Revision und den Freigabestatus besitzen, während das ERP Lieferant, Kosten, Durchlaufzeit, Bestand und Bestellungen besitzt.
Verfolgen Sie in der Demo ein Teil von seiner freigegebenen Revision bis zur zugehörigen Zeichnung und Baugruppe. Das sagt mehr über das Datenmodell aus als eine flache Dateiliste.
3. Events, Webhooks und Zuverlässigkeit
Eine API per Polling abzufragen kann für geplante Berichte oder kleine Datenmengen sinnvoll sein. Für einen freigabegetriebenen Workflow müssen Teams aber auch wissen, wie nachgelagerte Systeme erfahren, dass etwas Wichtiges sich geändert hat.
Das relevante Ereignis ist oft nicht „eine Datei wurde gespeichert“. Es kann ein Teil sein, das seinen freigegebenen Status erreicht, eine abgelöste freigegebene Revision oder ein genehmigtes ECO. Fragen Sie:
Welche Events können eine Benachrichtigung auslösen oder zuverlässig abgefragt werden?
Enthält jedes Event eine stabile Event-ID, einen Zeitstempel, eine Objekt-ID, eine Revision und einen Lebenszyklusstatus?
Können Konsumenten erkennen, ob ein Event mehrfach zugestellt oder in falscher Reihenfolge empfangen wurde?
Welches Zustellungs-, Wiederholungs- und Timeout-Verhalten ist dokumentiert?
Kann das Zielsystem nach einer Benachrichtigung den aktuellen freigegebenen Datensatz nachladen?
Gibt es Audit-Logs oder Korrelations-IDs, um einen fehlgeschlagenen Transfer systemweit nachzuverfolgen?
Konstruktionsintegrationen müssen doppelte Events und Wiederholungen vertragen. Eine Wiederholung nach einem Netzwerk-Timeout darf keine doppelten ERP-Positionen anlegen oder dieselbe Stücklistenaktualisierung zweimal anwenden. Der Webhook-Leitfaden von Stripe dokumentiert automatische Wiederholungen, den Umgang mit doppelten Events und Überlegungen zur Ereignisreihenfolge (im Zahlungskontext, aber mit Zustellungsmustern, die auch breiter auf ereignisgesteuerte Integrationen zutreffen).
Zeigen Sie vor dem Produktivbetrieb, was passiert, wenn das ERP nicht verfügbar ist oder eine Aktualisierung ablehnt. Manche Recovery-Mechanismen gehören in die Middleware oder die empfangende Anwendung und nicht in die PDM-API. Legen Sie fest, wer sie bereitstellt und pflegt.
Beispiel für einen PDM–ERP-Integrationstest: Eine freigegebene Revision erreicht das ERP erst nach erfolgreicher Stücklistenvalidierung. Fehlgeschlagene Aktualisierungen müssen protokolliert, korrigiert und sicher wiederholbar sein.
4. Tests und ein kontrollierter Proof of Concept
Eine sichere Testumgebung ist eines der stärksten Signale für Integrationsreife. Sie erlaubt es, Daten und Berechtigungen zu validieren, ohne produktive Konstruktions- oder ERP-Datensätze zu ändern.
Achten Sie auf:
Eine Sandbox, einen Test-Workspace oder einen nicht-produktiven Tenant;
Testzugangsdaten, die demselben Berechtigungsmodell wie die Produktion folgen;
Klare Beispieldaten oder ein kleines repräsentatives Produkt;
Dokumentation zu Fehlern, Rate Limits und Pagination;
Eine Möglichkeit, gelöschte, revidierte, obsolete und zugriffsbeschränkte Datensätze zu testen;
Einen kontrollierten Prozess zur Überführung einer Integration von Test in Produktion.
Wählen Sie eine freigegebene Baugruppe für den Nur-Lese-Test. Prüfen Sie Kennung, Revision, Lebenszyklusstatus, Stückliste und Dokumentenverweise gegen die Konstruktionsquelle. Ergänzen Sie in den Testdaten einen fehlenden Verweis auf ein untergeordnetes Teil, eine doppelte Kennung, eine abgelöste Revision und einen eingeschränkten Zugriff. Erfassen Sie für jeden Fall das erwartete Ergebnis und vergleichen Sie es mit der Antwort.
Erst wenn dieser Nur-Lese-Pfad verstanden ist, sollte das Team erwägen, operative Datensätze automatisch anzulegen oder zu aktualisieren.
Was Sie einen Anbieter demonstrieren lassen sollten
Bitten Sie den Anbieter im Rahmen eines fokussierten Proof of Concept, Folgendes zu demonstrieren:
Eine dokumentierte Anfrage und Antwort für ein freigegebenes Teil oder eine Baugruppe, einschließlich Revision, Lebenszyklusstatus und zugehöriger Datensätze;
Ein eingeschränktes Integrations-Credential und einen nicht-produktiven Workspace oder eine Sandbox;
Wie ein Freigabe-Event zugestellt, nachverfolgt, wiederholt und wiederhergestellt wird, wenn das Zielsystem nicht verfügbar ist;
Die API-Version, das Change-Log und die Deprecation-Policy, die für die Integration gelten würden.
Ein praktischer Pass/Fail-Test
Nutzen Sie dasselbe Szenario mit Revision B vom Anfang dieses Leitfadens. Reichen Sie in einer nicht-produktiven Umgebung eine freigegebene Baugruppe ein, deren Stückliste eine fehlende Mengeneinheit enthält, und simulieren Sie dann eine doppelte Freigabebenachrichtigung.
Der Test sollte vier Ergebnisse zeigen:
Validierung: Das ERP lehnt die unvollständige Stückliste mit einem identifizierbaren Fehler ab.
Umgang mit Duplikaten: Das wiederholte Event erzeugt keine doppelten ERP-Datensätze und führt nicht zur doppelten Anwendung derselben Stückliste.
Sichtbarkeit: Die Integration liefert einen nachvollziehbaren Status, der zeigt, dass die Aktualisierung der Revision B vom ERP abgelehnt und nicht erfolgreich synchronisiert wurde.
Wiederherstellung: Nach Korrektur des fehlenden Feldes lässt sich die Aktualisierung sicher wiederholen und ihre erfolgreiche Annahme verifizieren.
Halten Sie fest, welches System jede Fähigkeit bereitstellt. Validierung kann im ERP, Duplikatschutz in der Middleware und Freigabestatus-Tracking in der Integrationsebene stattfinden. Der Käufer sollte den gesamten Workflow bewerten, statt davon auszugehen, dass die PDM-API jede Kontrolle liefert.
5. Fehlerbehandlung und Versions-Governance
Sobald eine Integration im Tagesgeschäft läuft, muss jemand fehlgeschlagene Aktualisierungen untersuchen und sie über API-Änderungen hinweg pflegen. Beziehen Sie diese Person in die Bewertung ein.
Fragen Sie zur Fehlerbehandlung:
Sind Fehlerantworten strukturiert und spezifisch genug, um das fehlgeschlagene Objekt und den Grund zu identifizieren?
Gibt es eine Korrelations- oder Request-ID für Support- und Audit-Untersuchungen?
Können fehlgeschlagene Datensätze nach Beheben der Ursache erneut verarbeitet werden?
Gibt es eine sichtbare Ausnahmen-Queue, einen Alarm oder einen Export für Datensätze, die menschliche Prüfung erfordern?
Werden temporäre Fehler von ungültigen Daten oder Berechtigungsfehlern unterschieden?
Fragen Sie auch zum API-Change-Management:
Ist die API versioniert?
Wie werden Breaking Changes angekündigt?
Gibt es einen Deprecation-Zeitraum?
Sind Release Notes und Migrationsleitfäden verfügbar?
Lässt sich der Integrationsvertrag testen, bevor eine neue Version erforderlich ist?
Google AIP-185 bietet ein nützliches Beispiel für explizite Versionskennungen und dokumentierte Stabilitätsstufen. Die konkrete Versionierungsstrategie kann sich je nach Anbieter unterscheiden, aber Käufer sollten erwarten, dass der Lebenszyklus vor dem Produktiveinsatz klar ist.
Ein reifer Integrationsprozess behandelt eine fehlgeschlagene Validierung als sichtbare Ausnahme. Er sollte weder eine Stücklistenaktualisierung still überspringen, einen neueren Datensatz überschreiben noch das Team das Problem über einen Beschaffungsfehler entdecken lassen.
Eine praktische PDM-API-Evaluierung
Nutzen Sie dieses dreistufige Rahmenwerk, um eine PDM-API für den Produktiveinsatz zu bewerten. Ein „Nein“ schließt einen Anbieter nicht automatisch aus, zeigt aber, was vor dem Produktiveinsatz gelöst werden muss.
Die Übergabe definieren. Einigen Sie sich auf das Business-Event, das führende System und die Mindestdaten, die der Workflow benötigt.
Wir haben klare Eigentümerschaft, stabile Kennungen, eine definierte Revisionspolitik und einen Lebenszyklusstatus für die nachgelagerte Nutzung.
Der Zugriff ist eingegrenzt und auditierbar.
Die API liefert die Datensätze und Beziehungen, die der Workflow benötigt.
Einen kontrollierten Proof of Concept durchführen. Testen Sie ein freigegebenes Produkt, eingeschränkten Zugriff und die Fehlerfälle, die die Integration in Produktion abdecken muss.
Wir haben einen nicht-produktiven PoC durchgeführt.
Events, doppelte Zustellungen und Wiederholungen können nachverfolgt und sicher wiederhergestellt werden.
Produktionskontrollen einrichten. Definieren Sie Monitoring, Eigentümerschaft von Ausnahmen, Support-Eskalation und API-Change-Management.
Versions- und Änderungsmanagement sind dokumentiert.
Klare Eigentümerschaft ist für ungelöste Abhängigkeiten und die Fehlerbehandlung nach dem Launch zugewiesen.
Halten Sie Testergebnisse und offene Abhängigkeiten fest, bevor Sie sich für den Produktiveinsatz entscheiden.
Häufig gestellte Fragen
F: Was macht eine PDM-API integrationsreif?
A: Eine integrationsreife PDM-API unterstützt ein klar definiertes Konstruktionsdatenmodell, einen eingegrenzten und auditierbaren Zugriff, zuverlässigen Zugriff auf freigegebene Datensätze, einen sicheren Testpfad, diagnostizierbare Fehler und einen dokumentierten Ansatz für API-Versionsänderungen. Die reine Zahl der Endpoints ist kein nützliches Maß.
F: Reicht eine REST-API für die PDM–ERP-Integration?
A: Eine REST-API kann viele PDM–ERP-Workflows unterstützen, wenn das Team klare Kennungen, Datenhoheit und einen Freigabeprozess hat. Bewerten Sie zusätzlich, wie Änderungen entdeckt werden, wie Wiederholungen gehandhabt werden und ob die API die vom Workflow benötigten Beziehungen und Lebenszyklusinformationen bereitstellt.
F: Was sollten wir in einem PDM-API-Proof-of-Concept testen?
A: Beginnen Sie mit einem freigegebenen Produkt. Überprüfen Sie den Zugriff auf die korrekte Kennung, Revision, den Freigabestatus, relevante Stücklistendaten und kontrollierte Dokumentation. Testen Sie dann Fehlerfälle wie ein ungültiges untergeordnetes Teil, einen doppelten Datensatz, ein obsoletes Teil, eine geänderte Berechtigung und eine wiederholte Anfrage.
Planen Sie eine PDM-Integration? Buchen Sie eine Demo, um Ihren Konstruktionsdaten-Workflow und Ihre Integrationsanforderungen mit CAD ROOMS zu besprechen.
Ich bin Christina Rebel, CEO von CAD ROOMS. Seit über einem Jahrzehnt arbeite ich an der Schnittstelle von Cloud-Engineering-Kollaboration, digitaler Fertigung und verteilter Produktentwicklung.
In meiner Laufbahn habe ich eng mit Ingenieuren, Designern und Fertigungsteams zusammengearbeitet, um CAD-Datenmanagement, Versionskontrolle, Lieferantenkollaboration und browserbasierte Design-Reviews zu verbessern. Mein Fokus liegt darauf, moderne Engineering-Workflows zugänglicher, sicherer und effizienter zu machen – besonders für KMU und Start-ups.
Ich schreibe auch über Engineering-Kollaboration, mit Beiträgen in Design News und DEVELOP3D.
Erfahren Sie, was Engineering-Daten KI-tauglich macht – von CAD-Versionen und Stücklisten über Lebenszyklus, ECO und Berechtigungen bis zur Integration.
Der Artikel zeigt, welche Konstruktionsdaten wann von PDM an ERP übergehen sollten. Er behandelt Stücklisten, Revisionen, ECOs und einen schrittweisen Integrationsstart.