Eine Einführung in die öffentliche API von Lattice
In diesem Artikel erfahren Administratoren, wie sie die öffentliche API von Lattice nutzen können. Die API ermöglicht es Administratoren und Entwicklern, Daten von Lattice abzurufen und diese Informationen in einer anderen Anwendung zu verwenden.
Die API ermöglicht die Abfrage von Daten zu folgenden Themen:
- Benutzer
- Kompetenzen
- Feedback
- Goals
- Fragen
- Aufgaben
- Bewertungen
- Updates
Wenn Sie Entwickler sind und mehr über die API erfahren möchten, lesen Sie die Entwicklerdokumentation. Hier werden Sie oder Ihr Team mit den technischen Spezifikationen der API vertraut gemacht, einschließlich Authentifizierung, Paginierung, Erweiterung von Objekten und Grenzwerten. Außerdem finden Sie dort eine Echtzeit-Dokumentation darüber, welche Endpunkte und Felder für die oben genannten Abschnitte verfügbar sein werden.
Wenn Sie Lattice-Administrator sind und wissen möchten, wie Sie die API einrichten, folgen Sie dazu den nachstehenden Schritten.
Sie sind noch kein Kunde, möchten aber mehr über die API erfahren? Vereinbaren Sie eine Produkt-Demo!
Erste Fragen, die Sie sich zur API stellen sollten
- Wofür möchten Sie die API verwenden?
- Haben Sie einen Zeitstrahl für das Projekt?
- Haben Sie eine Person oder ein Team gefunden, die/das für den Aufbau verantwortlich ist?
Einen API-Schlüssel erstellen
- Navigieren Sie zu Admin > Organisation > Einstellungen > API-Schlüssel.
- Klicken Sie auf API-Schlüssel generieren.
- Nachdem der Schlüssel generiert wurde, klicken Sie auf Kopieren.
Hinweis: Der generierte API-Schlüssel wird Ihnen nur einmal vollständig angezeigt. Stellen Sie also sicher, dass Sie ihn kopieren, bevor Sie das Fenster schließen.
Nach der Erstellung des Schlüssels wird Ihnen ein Protokoll des Schlüssels angezeigt, in dem nur die letzten Zeichen des Schlüssels, der Benutzer, der den Schlüssel erstellt hat (identifiziert durch seine E-Mail-Adresse), und der Zeitpunkt der Erstellung des Schlüssels angegeben sind.
Ihren API-Schlüssel teilen
Sobald Sie einen API-Schlüssel erstellt haben, teilen Sie ihn mit den Personen, die für Ihren Build verantwortlich sind. Sie müssen dies auf sichere Weise tun und sicherstellen, dass der Schlüssel nicht an einem Ort verwahrt wird, zu dem andere Personen als die Lattice-Administratoren und die für die Erstellung verantwortlichen Personen Zugang haben.
Ihren API-Schlüssel widerrufen
- Navigieren Sie zu Admin > Organisation > Einstellungen > API-Schlüssel.
- Klicken Sie neben dem API-Schlüssel, den Sie widerrufen möchten, auf die rote Option Widerrufen.
Nach dem Widerrufen wird der Button in Text umgewandelt, und der Schlüssel kann keine Informationen mehr von Lattice abrufen.
Hinweis: Wenn der Benutzer, der den API-Schlüssel generiert hat, das Unternehmen verlassen hat und nicht mehr in Lattice aktiv ist, werden Anfragen, die mit diesem Schlüssel gestellt werden, abgelehnt. Ein Administrator muss einen neuen Schlüssel generieren und ihn dort nutzen, wo der vorhandene Schlüssel derzeit eingesetzt wird.
Ihren API-Schlüssel verwenden
Sobald ein Schlüssel generiert wurde, können Entwickler Daten von Lattice abrufen und die Ergebnisse mit dem Button zum Ausprobieren auf der API-Entwicklerseite testen.