Für: Administratoren
Erstellen Sie einen API-Schlüssel
Erstellen Sie einen Verwaltungsschlüssel für die API des Admin-Panels oder einen Hub-Schlüssel für die API des Portals, beschränken Sie ihn auf Ihre IP-Adressen und kopieren Sie ihn einmal.
In diesem Artikel8 Abschnitte
Eine API-SchlüsselwörterbuchSchlüssel Ein geheimer Token, der im Rahmen der Integration erstellt wird und es Ihrer eigenen Software ermöglicht, die API des Hubs zu nutzen. ermöglicht es Ihrem eigenen Softwareprogramm – beispielsweise einem Fallverwaltungssystem –, mit Ihrem Hub zu kommunizieren. Ein Schlüsselwörterbuch verwendet die API des Administrationspanels für die Verwaltung von Fällen und Personen. Ein Schlüsselwörterbuch des Portals hingegen nutzt die API des Portals selbst, um die Arbeit innerhalb der Fälle zu steuern. Verstehen Sie, was die API alles kann?
Schlüssel öffnen
Gehen Sie zu Integration › Schlüssel und wählen Sie NEU aus.
Benenne es
Unter Beschreibung beschreiben Sie, welche Funktionen damit verwendet werden können – zum Beispiel Case Sync.
Beschränken Sie die Verwendungsmöglichkeiten.
Unter Quell-CIDR geben Sie die öffentliche IPv4-Adresse ein, von der aus Ihr System Anrufe sendet – beispielsweise 203.0.113.10. Sie können auch einen Adressbereich angeben, wie zum Beispiel 203.0.113.0/24. Anrufe, die von anderen Orten kommen, werden abgewiesen. Das Hub-System erkennt nur IPv4-Adressen; daher wird eine IPv6-Adresse abgewiesen.
Falls Sie die Adresse noch nicht kennen, lassen Sie das Feld leer – dadurch kann jede Adresse verwendet werden. Nach dem ersten Aufruf Ihres Systems wird Zuletzt verwendete IP-Adresse diese Adresse anzeigen. Weitere Informationen finden Sie in Restriktionen oder Entzug einer API-Schlüsselwahl.
Wählen Sie den Typ aus
Unter Domain wählen Sie Manage für die API des Administrationspanels oder Hub für die API des Portals aus. Dies kann später nicht mehr geändert werden.
Schalte es ein und füge es hinzu.
Aktiv wird automatisch aktiviert. Lassen Sie es weiterhin aktiviert bleiben – eine inaktive Taste wird bei jeder Anrufabwicklung abgewiesen. Wählen Sie Schlüssel hinzufügen aus. „Taste hinzugefügt“ wird angezeigt.
Schlüssel kopieren
Die Geheimer Schlüssel-Fensterzeile zeigt den Schlüssel nur einmal an. Klicken Sie auf die Schaltfläche „Kopieren“, In die Zwischenablage kopieren, und speichern Sie den Schlüssel an einem Ort, an dem Ihr Entwickler ihn sicher abrufen kann – beispielsweise in einem Passwortmanager. Anschließend wählen Sie Getan aus.
Was geschieht als Nächstes?
Die wichtigsten Daten werden auf einmal übermittelt und verfallen nicht. Ihr Entwickler sendet diese Daten bei jedem Anruf. Siehe dazu… Authentifizieren der API-Anfragen mit einem Schlüssel. Es funktioniert als das Zentrum für Ihre Aktivitäten. 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 also die Beiträge des virtuellen Assistenten zeigen, ist…
Zuletzt verwendet und Zuletzt verwendete IP-Adresse zeigen das Datum sowie die Adresse der letzten Anrufe an. Um diese Informationen zu deaktivieren oder zu löschen, siehe Restriktionen oder Entzug eines API-Schlüssels.
Wenn etwas schiefgeht
- Die wichtigste Grenze wurde bereits erreicht. Ihr Hub kann jeweils zwei Schlüssel pro Typ haben. Löschen Sie einen der Schlüssel, den Sie nicht mehr verwenden.
- Laut der Quelle CIDR ist der Adressblock ungültig. Beispiel: 203.0.113.10 oder 203.0.113.0/24. Prüfen Sie die Adresse: vier Zahlen von 0 bis 255, mit Punkten dazwischen. Für den Bereich selbst sollte ein Slash verwendet werden, sowie eine Zahl bis zu 32.
- Laut der Quelle CIDR sollte man eine IPv4-Adresse oder einen IPv4-Addressbereich verwenden – beispielsweise 203.0.113.10. Die API ist nur über IPv4 erreichbar. Sie haben eine IPv6-Adresse eingetippt. Verwenden Sie stattdessen die IPv4-Adresse Ihres Systems.
- Sie haben den Schlüssel verloren. Es kann nicht noch einmal erstellt werden. Erstellen Sie ein neues Gerät, bewegen Sie Ihr System darauf und löschen Sie anschließend das alte Gerät. Wenn Ihr Hub bereits zwei solche Geräte besitzt, müssen Sie zuerst das alte Gerät löschen. Ihr System kann den Hub nicht nutzen, solange es nicht die neue Schlüsselkarte hat.