Private Integrations ermöglichen es dir, sichere, individuelle Verbindungen zwischen deinem ProfitBoost-Konto und jeder Drittanbieter-Anwendung zu erstellen. Dieses Feature ist ideal für interne Tools, automatisierte Workflows und maßgeschneiderte Systeme, die API-Zugriff benötigen, ohne eine vollständige öffentliche App zu bauen.
WICHTIG: Für eine vollständige Liste verfügbarer Endpoints sowie Request-/Response-Details besuche bitte unsere offizielle API-Dokumentation: https://marketplace.gohighlevel.com/docs/
INHALTSVERZEICHNIS
Was sind Private Integrations?
Was ist der Unterschied zwischen Private Integrations und API Keys?
Was ist der Unterschied zwischen Private Integrations und OAuth2 Access Tokens?
Wie nutze ich Private Integrations?
Private Integration mit API Calls testen
Wie verwalte ich Private Integrations?
Wo finde ich Private Integrations?
Wie erstelle ich eine neue Private Integration?
Welche Best Practices gibt es zur Sicherung meines Private-Integration-Tokens?
Token kompromittiert?
Kann ich die Private-Integration-Berechtigungen ändern, ohne das Token zu aktualisieren?
Wie lösche ich die Private Integration, wenn ich sie nicht mehr brauche?
Was sind Private Integrations?
Private Integrations ermöglichen es dir, leistungsstarke, individuelle Integrationen zwischen deinem ProfitBoost-Konto und jeder anderen Drittanbieter-App zu erstellen.
Wenn du dein ProfitBoost-Konto mit einer Drittanbieter-App integrieren möchtest, hast du zwei Optionen:
Die passende App aus dem App Marketplace finden und installieren
Deine eigene Private Integration selbst oder mit Hilfe eines Entwicklers über APIs erstellen
Private Integrations helfen dir, Punkt #2 sicher umzusetzen.
Die wichtigsten Vorteile von Private Integrations sind:
Einfach: Private-Integration-Tokens lassen sich direkt in den Kontoeinstellungen erstellen und einfach verwalten.
Sicher: Du kannst die Scopes/Berechtigungen einschränken, auf die ein Entwickler Zugriff hat.
Private Integrations sind sowohl für Agencies als auch für Sub-Accounts verfügbar. Um mehr über das Sub-Account-Feature für Private Integrations zu erfahren, klicke hier.
Was ist der Unterschied zwischen Private Integrations und API Keys?
Private Integrations sind vereinfacht gesagt eine sicherere und leistungsfähigere Alternative zu API Keys.
Private Integrations
Sicherer: Du kannst Scopes/Berechtigungen einschränken, auf die ein Entwickler Zugriff hat
State-of-the-art: Private Integrations ermöglichen Zugriff auf API v2.0, die modern ist
Mehr Features: API v2.0 bietet leistungsfähigere APIs
API Keys
Weniger sicher: Ein Entwickler erhält uneingeschränkten Zugriff auf alle deine Kontodaten
Veraltet: API v1.0 ist End-of-Life und wird nicht mehr gepflegt
Weniger Features: API v1.0 hat eingeschränkte APIs
Was ist der Unterschied zwischen Private Integrations und OAuth2 Access Tokens?
Private Integrations sind vereinfacht gesagt statische/feste OAuth2 Access Tokens.
Private Integrations
Über UI generiert: Das Private-Integration-Token kann einfach über die UI erstellt werden
Statisch/Fest: Tokens sind statisch und werden nicht automatisch aktualisiert, außer du rotierst sie in der UI
Access Tokens
Programmatisch generiert: Tokens werden durch Austausch eines OAuth Access Codes über die Get Access Token API erzeugt
Täglich aktualisiert: Access Tokens laufen täglich ab und müssen erneuert werden
Wie nutze ich Private Integrations?
Private-Integration-Tokens werden im Authorization Header verwendet, genau wie andere Access Tokens.
Beispiel: Um Details einer Location abzurufen, kannst du die Get Sub-account API mit dem Agency-Private-Integration-Token im Authorization Header nutzen.
curl --request GET \ --url https://services.leadconnectorhq.com/locations/ve9EPM428h8vShlRW1KT \ --header 'Accept: application/json' \ --header 'Authorization: <DEIN PRIVATE-INTEGRATION-TOKEN>' \ --header 'Version: 2021-07-28'Private Integration mit API Calls testen
Sobald deine Private Integration erstellt wurde, möchtest du sie möglicherweise testen, indem du Daten an einen API-Endpoint sendest. Dafür benötigst du die korrekte API-Endpoint-URL.
Hier ist ein Beispiel, wie du die Integration testest, indem du einen neuen Kontakt hinzufügst:
curl --request POST \ --url https://services.leadconnectorhq.com/contacts/ \ --header 'Authorization: <DEIN PRIVATE-INTEGRATION-TOKEN>' \ --header 'Content-Type: application/json' \ --header 'Version: 2021-07-28' \ --data '{ "firstName": "John", "lastName": "Doe", "email": "john.doe@example.com", "phone": "+1234567890", "locationId": "LOCATION_ID" }'Stelle sicher, dass du:
LOCATION_ID durch die tatsächliche Sub-Account-ID ersetzt.
Den Authorization-Wert durch dein generiertes Private-Integration-Token ersetzt.
Für eine vollständige Liste verfügbarer Endpoints und Testmöglichkeiten besuche bitte die offizielle Entwicklerdokumentation: https://developers.gohighlevel.com
Wie verwalte ich Private Integrations?
Wer kann Private Integrations erstellen?
Standardmäßig können alle Agency-Admins Private Integrations erstellen und verwalten.
Du kannst diese Berechtigung jedoch auf User-Ebene einschränken. Gehe dazu zu Einstellungen > Team > den jeweiligen Agency-Admin bearbeiten > Rollen & Berechtigungen und aktiviere/deaktiviere Private Integrations für den Agency-Admin.
Du kannst die Einschränkungen auf zwei Ebenen anwenden:
Dem Agency-Admin erlauben, die Private Integrations der Agency zu sehen und zu verwalten
Dem Agency-Admin erlauben, die Private Integrations der Sub-Accounts zu sehen und zu verwalten
Wo finde ich Private Integrations?
Du findest Private Integrations in den Agency-Einstellungen. Falls du sie nicht findest, stelle sicher, dass du das Feature in Labs aktiviert hast.
Wie erstelle ich eine neue Private Integration?
Schritt 1: Klicke auf „Create new Integration“
Schritt 2: Gib deiner Private Integration einen Namen und eine Beschreibung, damit du und dein Team sie leicht identifizieren können.
Schritt 3: Wähle die Scopes/Berechtigungen aus, auf die die Private Integration Zugriff in deinem Agency-Konto haben soll. Wähle nur die wirklich benötigten Scopes für bessere Datensicherheit.
Schritt 4: Kopiere das generierte Token und teile es mit deinem Drittanbieter-Entwickler.
Bitte stelle sicher, dass du das Token nur mit vertrauenswürdigen Parteien teilst. Nicht öffentlich teilen.
Hinweis: Vergiss nicht, das generierte Token zu kopieren, da du es später nicht erneut abrufen kannst.
Welche Best Practices gibt es zur Sicherung meines Private-Integration-Tokens?
Wir empfehlen, deine Private-Integration-Tokens alle 90 Tage zu rotieren.
So geht’s:
Schritt 1: Gehe zu Private Integrations in den Einstellungen und klicke auf die gewünschte Private Integration.
Schritt 2: Klicke auf „Rotate and expire this token later“.
Schritt 3: Klicke auf „Continue“, wenn du die Warnung bestätigst.
Schritt 4: Kopiere das neue Token und aktualisiere es in deiner Drittanbieter-App.
Du hast ein 7-Tage-Fenster, in dem sowohl das alte als auch das neue Token funktionieren. Danach läuft das alte Token ab. In diesem Zeitraum kannst du:
„Cancel rotation“ wählen, falls der Entwickler mehr Zeit braucht
oder „Expire Now“, wenn die App bereits aktualisiert wurde
Hinweis: Vergiss nicht, das Token zu kopieren, da du es später nicht erneut abrufen kannst.
Token kompromittiert?
Schritt 1: Gehe zu Private Integrations in den Einstellungen und klicke auf die entsprechende Private Integration.
Schritt 2: Klicke auf „Rotate and expire this token now“.
Schritt 3: Klicke auf „Continue“, wenn du die Warnung bestätigst.
Schritt 4: Kopiere das neue Token und aktualisiere es in deiner Drittanbieter-App.
Hinweis: Vergiss nicht, das Token zu kopieren, da du es später nicht erneut abrufen kannst.
Kann ich die Private-Integration-Berechtigungen ändern, ohne das Token zu aktualisieren?
Ja, du kannst Name, Beschreibung und Scopes/Berechtigungen jederzeit nach Erstellung ändern.
So geht’s:
Schritt 1: Gehe zu Private Integrations in den Einstellungen und wähle „Edit“ im Drei-Punkte-Menü.
Schritt 2: Aktualisiere Name und Beschreibung und klicke auf „Next“.
Schritt 3: Passe die Scopes/Berechtigungen an, falls nötig. Achte darauf, nur notwendige Scopes auszuwählen. Klicke auf „Update“, um zu speichern.
User können bis zu 5 Private-Integration-Tokens (PIT) auf Agency- und Location-Ebene erstellen.
Hinweis: Das Aktualisieren der Details erzeugt kein neues Token. Das bestehende Token bleibt weiterhin gültig.
Wie lösche ich die Private Integration, wenn ich sie nicht mehr brauche?
Du kannst die Private Integration löschen, sobald du die Drittanbieter-App nicht mehr nutzt. Gehe dazu zu Private Integrations in den Einstellungen und wähle „Delete“ im Drei-Punkte-Menü.
