Für: Administratoren
Verstehen Sie, was die API leisten kann.
Erfahren Sie, welche Funktionen eine Verwaltungstaste und eine Hub-Taste jeweils haben, warum jede Taste als virtueller Assistent fungiert und wo Sie die vollständige technische Auflistung finden.
In diesem Artikel2 Abschnitte
Die API ermöglicht es Ihrem eigenen Softwareprogramm – beispielsweise einem Fallverwaltungssystem –, mit Ihrem Hub zu kommunizieren, ohne dass jemand die Bildschirme benutzt. Die API wird mit einer API-SchlüsselSchlüssel Ein geheimer Token, der im Rahmen der Integration erstellt wird und es Ihrer eigenen Software ermöglicht, die API des Hubs zu nutzen. bezeichnet. Es gibt zwei Arten von API-Schlüsseln: einen Schlüssel für die Arbeit im Admin-Panel – beispielsweise bei der Verwaltung von Fällen und Personen – und einen Schlüssel für die Arbeit innerhalb der Fälle.
So funktioniert es
Zwei Schlüssel, zwei APIs. Jeder Schlüssel verwendet seine eigene Adresse. Darauf folgt die ID Ihres Zentrums. Diese Adressen werden von dem anderen Teil abgelehnt.
| Schlüssel | Adresse | Was es erreicht |
|---|---|---|
| Verwalten der wichtigen Elemente | https://prd-api-manage.caseactive.com/v1/<hub id>/ | Es geht um Fälle, die Personen betreffen, deren Zugang zu den Daten, ihre Rollen, die verschiedenen Phasen des Prozesses, sowie die Rechnungen, die man sich ansehen kann. Die Importvorgänge sind noch nicht abgeschlossen. https://prd-api-manage.caseactive.com/v1/integration/<hub id>/ |
| Hub-Taste | https://prd-api-app.caseactive.com/v1/<hub id>/ | Alles, was sich in jedem Fall befindet: Beiträge und Kommentare, Dateien, Formulare, elektronische Signaturn, Aufgaben, Rechnungen, Ereignisse, Notizen sowie die Details des Falls. |
Was für eine Funktion die „Manage Key“ denn haben kann… Nur diese. Alle anderen Anrufe im API-Panel des Administrationspanels ergeben eine Antwort mit der Codezeile 403. BotNotAllowedException.
- Fälle: Erstellen, Lesen, Aktualisieren und Löschen. Siehe Erstellen und Aktualisieren von Fällen mit der Funktion „Manage Key“.
- Mitglieder einer Kategorie: Erfassen, hinzufügen und entfernen von Mitglieder einer Kategorie. Siehe „Hinzufügen und Entfernen von Mitglieder einer Kategorie mit der Management-Funktion“.
- Personen: Listen, hinzufügen, lesen sowie deaktivieren oder wieder aktivieren. Siehe „Hinzufügen und Aktualisieren von Benutzern mit der Management-Taste“.
- Rollen und Phasen: Lesen Sie dazu „Lesen von Rollen mit der Schlüsselwort ‘Manage’“.
- Benutzerdefinierte Felder: Lesen Sie die Seiten mit den Daten der Fälle und der Benutzerdaten. Siehe Erstellen und aktualisieren von Fällen mithilfe einer Verwaltungsschlüssel.
- Rechnungen: Lesen Sie sie. Siehe Rechnungen mit der Funktion „Verwalten“ lesen.
- Suchen. Siehe Wie man Fälle und Benutzer mit der Management-Funktion sucht.
- Importe. Siehe „Einen Import mit der entsprechenden Schaltfläche ausführen“.
Jede Taste ist in Wirklichkeit Ihr virtueller Assistent. Hier sind einige wichtige Hinweise bezüglich Ihres Zentrums: Virtuelle Assistentin/Virtueller AssistentVirtueller Assistent Ein automatisiertes Teammitglied, das Begrüßungsnachrichten, Check-ins und Statusmeldungen für das Unternehmen veröffentlicht; seine Beiträge sind mit einem Virtual Assistant-Abzeichen versehen.. Was es postet, wird unter dem Namen und der Marke der virtuellen Assistentin angezeigt. Die Änderungen werden ebenfalls als „von der virtuellen Assistentin vorgenommen“ vermerkt. Die virtuelle Assistentin ist in jedem Fall vorhanden – somit erreicht eine Hub-Schlüssel alle Fälle im Hub. Sie kann alles tun, was die Rolle der virtuellen Assistentin erlaubt. Standardmäßig kann das Personal nur bestimmte Aufgaben durchführen. Ein geschlossener Fall ist für die virtuelle Assistentin nur in leseberechtigter Form zugänglich. Ein Hub-Schlüssel kann keine Fälle erstellen, Personen hinzufügen oder entfernen, Rechnungen bezahlen oder Anfragen beantworten.
Schlüssel verfallen nicht. Es handelt sich dabei um wichtige Daten, die bis zum Zeitpunkt des Ausschalts oder Löschens durch den Administrator aufbewahrt werden müssen. Beschränken Sie die Anzahl dieser Daten auf die öffentliche IPv4-Adresse Ihres Systems. Weitere Informationen finden Sie hier. Eine API-Schlüsselstellung zu beschränken oder zu widerrufen.
Die technischen Seiten. Jede API gibt eine vollständige technische Liste ihrer Anfragen aus – ohne dass dazu ein Account erstellt werden muss.
| Schlüssel verwalten | Hub-Schlüssel | |
|---|---|---|
| Interaktiv (Swagger UI) | https://prd-api-manage.caseactive.com/ | https://prd-api-app.caseactive.com/ |
| Referenz (ReDoc) | https://prd-api-manage.caseactive.com/redoc | https://prd-api-app.caseactive.com/redoc |
| OpenAPI-Dokumentation | https://prd-api-manage.caseactive.com/openapi.json | https://prd-api-app.caseactive.com/openapi.json |
Die Apps listen alle Anrufe auf, die sie selbst durchführen – darunter auch viele Anrufe, die mit der „Manage Key“-Funktion nicht abgewickelt werden können. Die Liste zeigt außerdem an, welche Funktionen mit der „Manage Key“-Funktion genutzt werden können. Um einen Anruf auf der interaktiven Seite auszuführen, wählen Sie Authorize aus und fügen anschließend Ihre Schlüsselwerte ein.
Ein abgeschlossenes Hubgerät. Während das Administrationspanel Ihres Servers nach einem fehlgeschlagenen Zahlungsvorgang gesperrt ist, wird der Zugriff auf die Managementfunktionen abgelehnt – mit dem Fehlercode 403. ManageBillingInactiveException. Ein Hub-Key funktioniert weiterhin, solange der Portalzugriff nur noch als Lesebereich möglich ist: 14 Tage nach dem fehlgeschlagenen Zahlungsversuch, wenn die Zahlung immer noch nicht bezahlt wurde – oder der Tag, an dem die abgebrochene Abonnementverbindung endet. Ab diesem Zeitpunkt kann der Hub-Key zwar weiterhin Daten lesen, aber jede Änderung wird abgelehnt, daher wird eine Fehlermeldung mit dem Code 403 ausgegeben. BillingReadOnlyException, Bis der Administrator die Abonnementfunktion erneut startet.
Wann man es verwendet
Verwenden Sie einen „Manage-Key“, um Ihr System in Einklang mit einem anderen System zu halten: Erstellen Sie Fälle, fügen Sie Kunden hinzu und legen Sie diese Kunden in die entsprechenden Fälle ein. Nehmen Sie außerdem den Zugang zu bestimmten Personen weg, wenn sie das System verlassen, oder laden Sie mehrere Datenzeilen auf einmal aus einem Datei-Format herunter. Nutzen Sie außerdem einen „Hub-Key“, um innerhalb der Fälle mit Ihrem eigenen Softwareprogramm zu arbeiten – beispielsweise um eine Notiz zu erstellen, wenn sich etwas in Ihrem System ändert.
Um über die Veränderungen in Ihrem Hub zu erfahren, sobald diese stattfinden – anstatt sie einzeln zu erwarten – sollten Sie einen Webhook verwenden. Weitere Informationen dazu finden Sie unter Webhook einrichten. Um eine Schlüsselwörter zu erstellen, siehe API-Schlüssel erstellen.