Automatisiere Dokument-Workflows in ProfitBoost mit den Public APIs für Dokumente und Verträge. Diese APIs ermöglichen Entwicklern das Auflisten von Dokumenten, das Versenden bestehender Dokumente an Kontakte, das Abrufen von Vorlagen sowie das Erstellen und Senden von Dokumenten aus Vorlagen ohne manuelle Arbeit. Dadurch lassen sich Datensätze synchronisieren, Dokumentversand aus externen Systemen auslösen und Vertragsprozesse innerhalb von ProfitBoost optimieren. Die Funktion ist Teil des umfassenden Documents & Contracts Bereichs in ProfitBoost und für die programmgesteuerte Nutzung vorgesehen.
INHALTSVERZEICHNIS
Was sind Documents & Contracts: Public APIs?
Wichtige Vorteile von Documents & Contracts: Public APIs
Dokumente auflisten
Dokument senden
Vorlagen auflisten
Vorlage senden
So richtest du Documents & Contracts Public APIs ein
Häufig gestellte Fragen
Verwandte Artikel
Was sind Documents & Contracts: Public APIs?
Documents & Contracts Public APIs geben Entwicklern die Möglichkeit, mit Dokument-Assets in ProfitBoost über API-Anfragen statt über manuelle Aktionen in der App zu arbeiten. Sie sind besonders nützlich, wenn ProfitBoost mit externen Systemen verbunden werden soll, wenn Dokumente aus eigenen Workflows heraus versendet werden oder wenn Dokumente dynamisch aus Vorlagen erstellt werden sollen. Diese APIs sind auf die jeweilige ProfitBoost-Location beschränkt und eignen sich für entwicklerbasierte Automatisierung.
Diese APIs unterstützen aktuell folgende Kernfunktionen:
Auflisten von Dokumenten innerhalb einer Location
Senden bestehender Dokumente an Kontakte
Auflisten von Vorlagen innerhalb einer Location
Erstellen und Senden von Dokumenten aus Vorlagen in einem Schritt
Wichtige Vorteile von Documents & Contracts: Public APIs
Public APIs für Documents & Contracts reduzieren manuelle Arbeit und verbinden Dokumentprozesse mit anderen Systemen im Tech-Stack. Besonders hilfreich für Unternehmen mit komplexen Automatisierungsanforderungen.
Automatisierter Dokumentversand: Dokumente direkt aus externen Tools oder Systemen senden
Effiziente Nutzung von Vorlagen: Dokumente in einem API-Call aus Templates erzeugen und versenden
Synchronisierte Daten: Dokument- und Vorlagenlisten für Reporting und Systemabgleich abrufen
Skalierbare Workflows: API-Trigger mit Folgeautomatisierungen kombinieren
Fehlerreduktion: Standardisierte Prozesse für Dokumenterstellung und Versand
Dokumente auflisten
Das Auflisten von Dokumenten ermöglicht es, alle Dokumente innerhalb einer ProfitBoost-Location abzurufen. Ideal für Integrationen, Reporting oder Synchronisation.
Du kannst den „List Documents“-Endpoint nutzen, um:
Dokumente einer Location abzurufen
Systeme mit ProfitBoost zu synchronisieren
Interne Tools mit Dokumentdaten zu versorgen
Doppelanlagen zu vermeiden
Dokument senden
Mit dem „Send Document“-Endpoint kannst du bestehende Dokumente automatisch an Kontakte versenden. Dies eignet sich für externe Trigger oder individuelle Business-Logik.
Du kannst den Endpoint nutzen, um:
Ein bestehendes Dokument an Kontakte zu senden
Versand aus externen Formularen oder Apps auszulösen
Standardisierte Versandprozesse zu automatisieren
Manuelle Schritte im Sales- oder Onboarding-Prozess zu reduzieren
Hinweis:
Das Dokument muss bereits in ProfitBoost existieren
Versandlogik folgt den API-Vorgaben
API-Sends können mit Workflow-Automatisierungen kombiniert werden
Vorlagen auflisten
Mit dem Auflisten von Templates können Entwickler alle verfügbaren Dokumentvorlagen innerhalb einer Location abrufen.
Du kannst den „List Templates“-Endpoint nutzen, um:
Vorlagen einer Location abzurufen
Template-Auswahl in externen Tools bereitzustellen
Verfügbarkeit vor Dokumenterstellung zu prüfen
Standardisierte Prozesse zu unterstützen
Vorlage senden
Mit dem „Send Template“-Endpoint kannst du ein Dokument aus einer Vorlage erstellen und direkt versenden.
Du kannst den Endpoint nutzen, um:
Ein neues Dokument aus einer Vorlage zu erzeugen
Das Dokument sofort zu versenden
Wiederkehrende Prozesse zu automatisieren
Personalisierte Dokumente aus externen Systemen zu starten
Besonders geeignet für:
Standardisierte Angebote und Verträge
Kontaktbasierte Dokumenterstellung
Externe Trigger-Workflows
So richtest du Documents & Contracts Public APIs ein
Stelle sicher, dass benötigte Dokumente und Templates in der richtigen Location vorhanden sind
Prüfe die aktuelle ProfitBoost API-Dokumentation
Wähle die passende Authentifizierung (z. B. Private Integration oder OAuth)
Achte auf den korrekten Location-Kontext in API-Requests
Teste die Endpoints (List, Send, Templates)
Verbinde API-Events mit Workflow-Automationen
Häufig gestellte Fragen
Q: Sind Public APIs nur für Entwickler gedacht?
Ja, sie sind für programmatische Integrationen und Automatisierungen gedacht.
Q: Was ist der Unterschied zwischen „Send Document“ und „Send Template“?
Send Document verschickt ein bestehendes Dokument, Send Template erstellt zuerst ein neues Dokument aus einer Vorlage.
Q: Kann ich Workflows durch APIs ersetzen?
Teilweise ja – APIs eignen sich für externe Logik, Workflows für No-Code-Automationen innerhalb von ProfitBoost.
Q: Unterstützen APIs bestehende Templates?
Ja, Templates aus ProfitBoost können über APIs genutzt werden.
Q: Kann ich Follow-ups automatisieren?
Ja, über Workflow-Trigger nach dem Versand (z. B. viewed, signed, completed).
Q: Brauche ich Private Integrations?
Nicht zwingend – hängt vom Integrationsszenario ab.
Q: Was bedeutet „Location“?
Eine Location ist der Datenkontext innerhalb von ProfitBoost, in dem Dokumente und Templates gespeichert sind.
Q: Kann ich alle Dokumentaktionen über APIs steuern?
Nein, aktuell sind vor allem Listen- und Versandaktionen abgedeckt.