JSON API

JSON-API einrichten und externe Systeme mit HalloLuci verbinden

Mit der JSON-API können externe Systeme direkt auf Daten von HalloLuci zugreifen und diese verarbeiten. Im Gegensatz zum Webhook, bei dem HalloLuci Daten automatisch versendet, können externe Anwendungen über die API Daten abrufen, erstellen oder aktualisieren.

Dadurch lassen sich individuelle Integrationen mit CRM-Systemen, Kundenportalen, Automatisierungsplattformen oder eigenen Anwendungen realisieren.

Verfügbar ab Paket Complete

Was ist die JSON-API?

Die JSON-API stellt eine REST-Schnittstelle zur Verfügung, über die externe Systeme mit HalloLuci kommunizieren können.

Je nach erteilten Berechtigungen können Anwendungen beispielsweise:

Kontakte abrufen und verwalten
Anrufdaten auslesen
Kalenderinformationen verarbeiten
Daten automatisiert synchronisieren
Eigene Anwendungen mit HalloLuci verbinden

Die Kommunikation erfolgt über HTTP-Anfragen und Antworten im JSON-Format.

JSON-API einrichten

Schritt 1: Neue Schnittstelle anlegen

Öffnen Sie den Menüpunkt Schnittstellen.
Klicken Sie auf Neue Schnittstelle.
Wählen Sie den Schnittstellen-Typ JSON-API aus.

Schritt 2: Name vergeben und Berechtigungen festlegen

Vergeben Sie einen frei wählbaren Namen für die Schnittstelle.

Anschließend wählen Sie aus, auf welche Datenbereiche die API zugreifen darf:

Kontakte
Anrufe
Kalender

Aktivieren Sie nur die Berechtigungen, die für Ihre Integration tatsächlich benötigt werden.

Klicken Sie anschließend auf Anlegen.

Schritt 3: API-Token speichern

Nach dem Anlegen der Schnittstelle wird automatisch ein API-Token erzeugt.

Speichern Sie den Token daher sofort an einem sicheren Ort.

Der Token wird für die Authentifizierung Ihrer API-Anfragen benötigt.

Schritt 4: API-Token verwenden

Bei API-Aufrufen muss der Token als HTTP-Header übertragen werden.

Verwenden Sie dazu folgenden Header:

Authorization: Bearer IHR_API_TOKEN

Ohne gültigen API-Token können externe Systeme nicht auf die JSON-API zugreifen.

Schritt 5: API-Dokumentation öffnen

Innerhalb der Schnittstelle finden Sie einen Link zur API-Dokumentation.

Dort finden Sie unter anderem:

Verfügbare Endpunkte
Anfrageparameter
Antwortformate
Authentifizierung
Beispielanfragen
Technische Implementierungsdetails

Die Dokumentation ist die zentrale Grundlage für die Entwicklung Ihrer Integration.

Welche Daten können genutzt werden?

Abhängig von den vergebenen Berechtigungen können externe Systeme auf folgende Bereiche zugreifen:

Kontakte
Anrufe
Kalender

Welche Funktionen innerhalb dieser Bereiche zur Verfügung stehen, entnehmen Sie bitte der API-Dokumentation.

Mögliche Anwendungsfälle

Die JSON-API eignet sich beispielsweise für:

Individuelle CRM-Anbindungen
Eigene Kundenportale
Interne Verwaltungssoftware
Automatisierte Datenabgleiche
Individuelle Dashboards
Business-Intelligence-Lösungen
Eigene Apps und Softwareprojekte

Wichtiger Hinweis zu Support und technischen Voraussetzungen

Die JSON-API richtet sich an technisch versierte Anwender, Entwickler und IT-Dienstleister.

Für die Nutzung sind Kenntnisse in folgenden Bereichen erforderlich:

REST-APIs
HTTP-Anfragen
JSON-Datenformate
Authentifizierung mittels API-Token
Verarbeitung von API-Antworten

Bitte beachten Sie:

HalloLuci stellt die API und die zugehörige Dokumentation bereit.
Die Entwicklung und Implementierung erfolgt eigenverantwortlich.
Individuelle Programmierungen und Integrationen werden nicht durch den HalloLuci-Support unterstützt.
Fehleranalysen innerhalb externer Anwendungen oder eigener Softwareprojekte sind nicht Bestandteil unseres Leistungsumfangs.

Falls Sie keine Erfahrung mit APIs besitzen, empfehlen wir die Umsetzung durch einen Entwickler oder technischen Dienstleister.

Bewahren Sie Ihren API-Token sicher auf. Sollte der Token verloren gehen oder kompromittiert werden, empfehlen wir, die Schnittstelle neu anzulegen und einen neuen Token zu verwenden.