Zum Hauptinhalt springen

API von Professional Works – Häufige Fragen

Hier finden Sie die Antworten auf die häufigsten Fragen zur API von Professional Works – von Zugang und Authentifizierung über den Funktionsumfang bis zu den Rahmenbedingungen.

Was ist die API und was kann sie?

Die API ermöglicht es, Professional Works mit externen Systemen und Tools zu verbinden. Statt Daten manuell in der Oberfläche einzugeben oder abzurufen, können Informationen automatisiert ausgetauscht werden.

Konkret unterstützt die API zwei grundlegende Funktionen:

  • Daten schreiben: Neue Daten können in Professional Works angelegt werden, um Prozesse zu automatisieren und externe Tools effizient anzubinden.

  • Daten abrufen: Bestehende Daten, die bereits in Professional Works vorhanden sind, können abgerufen werden, um sie in eigene Prozesse einzubinden.

In Verbindung mit Automatisierungs-Tools wie Make lässt sich die Nutzung der API noch flexibler gestalten, sodass Arbeitsabläufe weiter optimiert werden können.

Zugang & Authentifizierung

Wie erhalte ich einen API-Token?

Einen API-Token erhalten Sie ausschließlich mit einem Account bei Professional Works. Sie erstellen ihn selbst unter Startseite → Marktplatz → API-Token-Verwaltung: mvp.professional.works/api-token

Dort sehen Sie auch, welche Endpoints Ihnen zur Verfügung stehen.

Wo finde ich die API-Dokumentation?

Alle Endpunkte mit ihren Feldern sind in der OpenAPI-Dokumentation beschrieben: apimanager.professional.works/api/v1/docs

Wie funktioniert die Authentifizierung?

Die Authentifizierung erfolgt per Bearer-Token im Authorization-Header:

Authorization: Bearer <Ihr Token>

Eine separate Client-ID oder Benutzerkennung benötigen Sie nicht, da der Token bereits an Ihren Benutzer gebunden ist.

Kann ich die Rechte eines bestehenden Tokens ändern?

Nein. Die Rechte eines Tokens lassen sich nachträglich nicht anpassen. Benötigen Sie weitere Rechte, erstellen Sie bitte einen neuen Token. Jeder Token ist an den Benutzer gebunden, der ihn erstellt hat.

Welche Berechtigungen gibt es, und auf welche Daten habe ich Zugriff?

In der API-Token-Verwaltung legen Sie fest, welche Berechtigungen ein Token hat: Lesen, Anlegen, Ändern und Löschen.

Auf welche Daten Sie zugreifen können, richtet sich immer nach dem Benutzer, zu dem der Token gehört:

  • Hauptvermittler: Zugriff auf sämtliche Bestände der Firma.

  • Vermittler weiter unten in der Hierarchie: Zugriff nur auf die Daten des eigenen Accounts und der darunterliegenden Benutzer.


Funktionsumfang

Welche Daten und Funktionen stehen über die API zur Verfügung?

Die API ist eine REST-API und umfasst die Grunddaten aus Professional Works zu Kunden, Verträgen und Dokumenten. Alle Partner auf unserem Marktplatz nutzen diese API auch für ihre eigenen Integrationen.

Was Sie konkret abrufen, anlegen, ändern oder löschen können, ergibt sich aus zwei Quellen:

  • API-Token-Verwaltung in Professional Works: Hier sehen Sie, welche Zugriffe möglich sind.

  • OpenAPI-Dokumentation: Hier finden Sie die zugehörigen Endpoints mit allen Feldern – apimanager.professional.works/api/v1/docs

Hinweis: Die OpenAPI-Dokumentation umfasst alle API-Endpunkte, die wir im Unternehmen bereitstellen – auch solche für interne Zwecke. Für Ihren Token steht bewusst nur ein Teil davon zur Verfügung. Maßgeblich ist daher immer der Umfang, der in der API-Token-Verwaltung angezeigt wird.

Welche Daten werden im Investment-Bereich ausgelesen?

Bisher werden nur die Grund- und Stammdaten des Vertrags ausgelesen, keine Detailinformationen.

Gibt es Endpunkte für das BiPRO-Postfach?

Nein, für das BiPRO-Postfach gibt es keinen eigenen Endpunkt.

Gibt es Webhooks oder eine Abfrage für Änderungen seit dem letzten Abruf?

Nein, Webhooks oder eine gesonderte Änderungsabfrage gibt es derzeit nicht.


Rahmenbedingungen

Fallen Kosten an?

Nein, die Nutzung der API ist kostenlos.

Gibt es eine Test- oder Sandbox-Umgebung?

Nein. Wenn Sie testen möchten, empfehlen wir, einen Test-Account anzulegen. Alternativ kann sich ein einzelner Benutzer in Ihrer Firma einen eigenen Token erstellen und damit testen.

Gibt es Begrenzungen für Abfragen?

Ja, das Rate Limit liegt bei 60 Requests pro Minute.

Wie sind Datenschutz und Auftragsverarbeitung geregelt?

Ihre Daten liegen dort, wo sie auch bisher liegen. Gegenüber den Daten in Professional Works ändert sich nichts. Alles Weitere ist bereits in der Vereinbarung zur Auftragsverarbeitung geregelt, die Sie bei Ihrem Beitritt mit uns geschlossen haben.

Wie erfahre ich von Änderungen an der API?

In der API gibt es im Bereich „Allgemein“ einen Deprecations-Endpunkt. Dort sehen Sie jederzeit, welche Änderungen anstehen. Bereits vorgenommene Änderungen stellen wir aktuell nicht nachträglich zur Verfügung.

Zusätzlich informieren wir in der Regel zwei bis drei Monate vor anstehenden Änderungen bzw. Deprecations per E-Mail. Die Information geht an alle Professional-Works-User und Produktanbieter, die einen Token besitzen und ihn in den letzten drei Monaten genutzt haben.


Weitere Produkte & Integrationen

Kann ich DEMV Sign oder Vorgänge über die API nutzen?

Nein, aktuell nicht. DEMV Sign und Vorgänge sind eigenständige Produkte von Professional Works und laufen nicht über diese API. Eine Verbindung der APIs ist derzeit nicht möglich.

Gibt es einen MCP-Server oder eine Schnittstelle für KI-Assistenten?

Nein, einen MCP-Server gibt es derzeit nicht.

Ich möchte Abläufe automatisieren, z. B. mit Make, WhatsApp oder KI. Wie gehe ich vor?

Automatisierungen bauen Sie eigenständig auf. Wir stellen Ihnen dafür die Endpunkte und die darin enthaltenen Funktionen zur Verfügung. Eine Unterstützung oder einen Support beim Aufbau von automatisierten Abläufen bieten wir nicht an.

Wenn Sie keine eigene Lösung aufbauen möchten, lohnt sich ein Blick auf die Anbieter auf unserem Marktplatz, die unsere API bereits nutzen.

Fehlen Ihnen Informationen oder Funktionen in der API, nutzen Sie gerne wie gewohnt die Wunschliste für Erweiterungen.


Risiken der automatisierten Datenänderung

Die Automatisierung von Datenänderungen über die API bringt neben dem Effizienzgewinn auch Risiken mit sich, die vor der Einrichtung eigener Prozesse bedacht werden sollten.

Anders als bei der manuellen Eingabe über die Oberfläche gibt es bei automatisierten Schreibvorgängen in der Regel keine Zwischenkontrolle durch eine Person, die Fehler vor dem Speichern erkennt und korrigiert. Ein Fehler in der eigenen Automatisierung, im Mapping von Feldern oder in der Logik eines angebundenen Tools (z. B. Make oder einer selbst entwickelten Schnittstelle) kann sich dadurch sehr schnell und in großem Umfang auswirken – etwa wenn ein fehlerhafter Prozess in kurzer Zeit eine große Anzahl an Datensätzen anlegt, überschreibt oder dupliziert, statt nur einen

einzelnen Kunden zu betreffen.

Besonders kritisch sind Szenarien, in denen bereits bestehende Kundendaten durch fehlerhaft befüllte oder falsch zugeordnete Werte überschrieben werden, da dies unter Umständen erst spät auffällt, wenn bereits an anderer Stelle mit

den betroffenen Daten weitergearbeitet wurde. Auch das Anlegen von Dubletten

(z. B. mehrfach angelegte Kunden durch fehlerhafte Abgleichslogik) kann in der Praxis zu Verwirrung, doppelter Arbeit oder inkonsistenten Datenständen führen.

Zusätzlich ist zu beachten, dass API-Tokens grundsätzlich wie ein Passwort zu behandeln sind: Gelangt ein Token in falsche Hände oder wird es in einem unsicheren System oder einer unsicheren Automatisierung hinterlegt, können

Dritte darüber auf Kunden- und Vertragsdaten zugreifen oder diese verändern.

Wer eigene Anbindungen oder Automatisierungen aufbaut, sollte diese daher vorab in einem überschaubaren Rahmen testen, Berechtigungen von Tokens so restriktiv wie möglich vergeben und größere automatisierte Schreibvorgänge nicht ungetestet auf den vollständigen Datenbestand anwenden.


Nutzung auf eigene Gefahr

Die Nutzung der PW API erfolgt eigenverantwortlich und auf eigene Gefahr. Datenänderungen, die über die API vorgenommen wurden – sei es durch eigene Automatisierungen, angebundene Drittsysteme oder Tools wie Make –

können von uns nicht rückgängig gemacht werden.

Wir empfehlen daher, eigene Integrationen sorgfältig zu testen, bevor sie im produktiven Bestand eingesetzt werden.

Hat dies deine Frage beantwortet?