Was ist neu?
Documents & Contracts: Öffentliche APIs ermöglichen dir, Dokument-Workflows direkt innerhalb von HighLevel zu automatisieren. Mit diesen APIs kannst du Dokumente und Templates listen, senden und verwalten und manuelle Prozesse eliminieren sowie Integrationen mit externen Systemen vereinfachen.
TABLE OF CONTENTS
Was ist Documents & Contracts: Public APIs?
Documents & Contracts: Public APIs bieten Entwicklern programmatischen Zugriff auf zentrale Dokument- und Vertragsfunktionen in HighLevel. Damit kannst du Dokumente abrufen, an Kontakte senden, Templates abrufen und Dokumente aus Templates erstellen und direkt versenden. Diese APIs helfen dabei, Workflows zu automatisieren, Konsistenz sicherzustellen und Dokument-Management zu skalieren.
Key Benefits der Documents & Contracts: Public APIs
• Dokument-Listen: Vollständige Dokumentenübersicht für Tracking und Reporting abrufen
• Automatisiertes Senden: Dokumente direkt an Kontakte senden ohne manuelle Schritte
• Template-Zugriff: Templates schnell abrufen und für Automationen nutzen
• One-Step Erstellung & Versand: Dokumente aus Templates in einem API Call erstellen und senden
• Seamless Integration: Verbindung mit externen Systemen zur Reduzierung manueller Prozesse
List Documents
Der List Documents Endpoint ermöglicht das Abrufen aller Dokumente einer HighLevel Location. Ideal für CRM-Synchronisation, Dashboards oder eigene Apps.
• Vollständige Dokumentenliste abrufen
• Dokumentdaten in Echtzeit synchronisieren
• Integrationen mit Metadaten versorgen
Send Document
Mit dem Send Document Endpoint kannst du bestehende Dokumente automatisch an einen oder mehrere Kontakte versenden.
• Bestehendes Dokument auswählen
• Einen oder mehrere Empfänger definieren
• Versand vollständig automatisieren
List Templates
Der List Templates Endpoint liefert alle verfügbaren Templates einer Location.
• Zentrale Template-Übersicht abrufen
• Passende Templates dynamisch auswählen
• Automationen mit aktuellen Templates versorgen
Send Template
Der Send Template Endpoint kombiniert Erstellung und Versand in einem Schritt.
• Dokument aus Template generieren
• Direkt an Kontakte senden
• Prozesse stark vereinfachen
How To Set Up Documents & Contracts: Public APIs
Schritt 1: API Credentials erhalten
Gehe zu Agency Settings > Private Integrations und erstelle einen Private Integration Token (empfohlen für mehr Sicherheit).
WICHTIG: Scopes bestimmen die Berechtigungen einer Integration. Vergib nur notwendige Scopes für maximale Sicherheit.
Schritt 2: API Dokumentation prüfen
Öffne das Public API Dokumentationsportal und wähle benötigte Endpoints (List, Send, Templates etc.).
Schritt 3: API Calls testen
Nutze Tools wie Postman und setze den Header:
Authorization: Bearer
Schritt 4: Responses validieren
Prüfe die JSON Responses und stelle sicher, dass Daten korrekt zurückgegeben oder gesendet werden.
Schritt 5: Integration umsetzen
Binde API Calls in CRM, Workflows oder Backend-Systeme ein. Optional kombinierbar mit Workflow-Triggern wie „Document Signed“.
Schritt 6: Sicher deployen
Tokens sicher speichern, regelmäßig rotieren und API Limits überwachen.
Frequently Asked Questions
Q: Welche Endpoints sind enthalten?
List Documents, Send Document, List Templates, Send Template
Q: Wo finde ich die offizielle Dokumentation?
Im HighLevel Public API Portal
Q: Benötige ich spezielle Berechtigungen?
Ja, API Credentials (Private Integration Tokens) sind erforderlich
Q: Wie teste ich APIs sicher?
Mit Tools wie Postman vor dem Live-Einsatz
Q: Unterschied zwischen Document und Template?
Ein Document ist eine konkrete Datei, ein Template eine Vorlage zur Generierung neuer Dokumente