Manuelle Aufgaben in der Awardco-Plattform, wie das Hochladen von Benutzerdateien oder das Erstellen von Berichten, können mühsam und zeitaufwendig sein. Durch die Verwendung von API-Schlüsseln können Sie diese Prozesse automatisieren und so Zeit und Aufwand sparen. Dieser Artikel erklärt, was API-Schlüssel sind, welche Funktionen sie haben und wie Sie sie innerhalb Ihrer Organisation über das API-Schlüssel-Verwaltungstool nutzen können.
Was ist eine API?
API (Application Programming Interface) ist eine Möglichkeit, wie zwei Programme miteinander kommunizieren können. Sie stellt eine Reihe von Befehlen und Anfragen bereit, die ein Programm (wie Awardco) von externen Quellen akzeptieren kann. Die meisten mobilen Apps verwenden APIs, um mit ihren übergeordneten Systemen zu kommunizieren.
Die API von Awardco verwendet HTTP, dasselbe Protokoll wie Websites, was die Kommunikation vereinfacht und es ermöglicht, API-Aufrufe direkt aus einem Browser heraus zu tätigen.
Die API von Awardco unterstützt zwei Hauptanfragetypen:
- GET: Fordert Informationen aus der Datenbank an, z. B. das Abrufen von Berichten im .csv- oder .json-Format.
- POST: Aktualisiert Informationen in der Datenbank. Zum Beispiel können Sie damit Benutzer aktualisieren, Anerkennungen posten oder Belohnungen verwalten.
Was ist mit der API möglich?
Typische Anwendungsfälle für die API von Awardco sind:
- Hochladen von Benutzerdateien in Awardco.
- Abrufen von Berichten im .csv- oder .json-Format.
- Automatisierung von Auszeichnungen und Anerkennungen.
- Abrufen von Social-Feed-Informationen zur Anzeige.
- Interaktion mit der Plattform zur Erstellung von Anwendungen.
Um eine Datei per API zu senden, muss die Datei zugänglich und korrekt kodiert sein. Es gibt drei Hauptmethoden, dies zu handhaben:
- Speichern der Datei auf einem FTP- oder öffentlich zugänglichen Server.
- Verwendung eines API-Dienstes (z. B. Postman) zum Erstellen der Anfrage.
- Verwendung von Programmiersprachen wie C#, cURL oder JavaScript zum Senden der Anfrage.
Obwohl die API einen leistungsstarken Zugriff auf die Awardco-Plattform bietet, sind die Kunden vollständig für deren Verwendung verantwortlich.
Weitere Informationen finden Sie in unserer öffentlichen API-Dokumentation.
Aktivieren der Berechtigung für API-Schlüssel
Standardmäßig können nur Super-Admin-Benutzer API-Schlüssel verwalten. Um anderen Rollen die Verwaltung und Erstellung von API-Schlüsseln zu erlauben:
- Klicken Sie oben rechts auf der Startseite auf die Schaltfläche Admin.
- Navigieren Sie zum Tab Einstellungen.
- Wählen Sie im linken Menü Berechtigungen aus.
- Klicken Sie auf das Drei-Punkte-Symbol neben der Rolle, die Sie bearbeiten möchten, und wählen Sie Bearbeiten.
- Navigieren Sie zu den Berechtigungseinstellungen und aktivieren Sie das Kontrollkästchen neben „API-Schlüssel“.
- Klicken Sie auf Speichern & Anwenden.
Zugriff auf das API-Schlüssel-Verwaltungstool
Awardco stellt ein spezielles API-Schlüssel-Verwaltungstool bereit, mit dem Sie spezifische API-Schlüssel für verschiedene Aktionen verwalten können, wie z. B. das Senden von Anerkennungen, Abrufen von Feeds oder Erstellen von Benutzern. Anstatt einen einzigen allmächtigen API-Schlüssel zu verwenden, unterteilt Awardco die Schlüssel in separate Aktionen, basierend auf Ihren Bedürfnissen.
So greifen Sie auf das API-Schlüssel-Verwaltungstool zu:
- Wählen Sie oben rechts auf der Startseite die Schaltfläche „Admin“ aus.
- Klicken Sie auf den Tab „Einstellungen“.
- Klicken Sie im linken Menü auf „API-Schlüssel“.
Im API-Schlüssel-Verwaltungstool können Sie:
- Spezifische API-Schlüssel für verschiedene Aufgaben anzeigen und verwalten (z. B. Senden von Anerkennungen, Abrufen von Berichten).
- Rollen und Berechtigungen zuweisen, wer API-Schlüssel innerhalb Ihrer Organisation verwalten darf.
- Nachverfolgen, wer jeden API-Schlüssel erstellt hat und wann.
- Sicherstellen, dass API-Schlüssel gehasht und gesalzen sind (sie werden nicht im Klartext gespeichert).
- API-Schlüssel bei Bedarf löschen.
- Beachten Sie, dass Benutzer, die sich als andere ausgeben, keine API-Schlüssel generieren können.
- API-Schlüssel sicher an vertrauenswürdige Personen senden.
Erstellen eines neuen API-Schlüssels
So erstellen Sie einen neuen API-Schlüssel:
- Klicken Sie auf der Seite „API-Schlüssel“ auf die Schaltfläche + Neuer API-Schlüssel.
- Geben Sie einen Schlüsselnamen ein.
- Wählen Sie die Berechtigungen aus, die der Schlüssel haben soll.
- Wenn Sie einen API-Schlüssel für eine Awardco-Integration einrichten, lesen Sie den Abschnitt Erforderliche Berechtigungen für Integrationen weiter unten.
- Legen Sie den Ablaufzeitraum oder das Ablaufdatum des Schlüssels fest.
- Das maximale Ablaufdatum liegt drei Jahre ab dem heutigen Datum. Es wird empfohlen, API-Schlüssel regelmäßig auszutauschen.
- Klicken Sie auf Weiter.
- Wählen Sie, ob Sie den Schlüssel sofort generieren oder sicher an eine andere Person senden möchten.
- Überprüfen Sie die Details und schließen Sie den Vorgang ab, indem Sie auf API-Schlüssel generieren oder sicher senden klicken.
Wichtig: Kopieren und speichern Sie den API-Schlüssel sofort nach der Generierung sicher. Aus Sicherheitsgründen wird er nicht erneut angezeigt. Für weitere Informationen zu bewährten Methoden und Tipps zu API-Schlüsseln lesen Sie diesen Support-Artikel.
Verwalten von API-Schlüsseln
Anzeigen und Bearbeiten von API-Schlüssel-Details
So zeigen Sie Details eines API-Schlüssels an:
- Klicken Sie auf den Namen des API-Schlüssels, um ein Detailfenster zu öffnen, das Folgendes anzeigt:
- Schlüsselnamen.
- Die ersten sechs Ziffern des Schlüssels.
- Name des Erstellers.
- Status.
- Berechtigungen.
- Erstellungsdatum.
- Ablaufdatum.
- Datum der letzten Verwendung.
Um den Namen oder das Ablaufdatum eines API-Schlüssels zu bearbeiten, klicken Sie auf Bearbeiten und nehmen Sie die Änderungen vor. Speichern Sie Ihre Änderungen anschließend.
Widerrufen eines API-Schlüssels
Das Widerrufen eines API-Schlüssels deaktiviert ihn dauerhaft, wodurch alle damit verbundenen Integrationen nicht mehr funktionieren. Diese Aktion kann nicht rückgängig gemacht werden.
So widerrufen Sie einen API-Schlüssel:
- Klicken Sie auf das Drei-Punkte-Symbol neben dem Schlüssel.
- Wählen Sie Widerrufen.
- Bestätigen Sie mit Klick auf API-Schlüssel widerrufen.
Widerrufene Schlüssel werden in den Tab Archiviert verschoben.
Erneutes Senden eines API-Schlüssels
Wenn ein API-Schlüssel den Status „Nicht akzeptiert“ anzeigt oder nicht innerhalb von 24 Stunden akzeptiert wurde, können Sie ihn erneut senden.
- Klicken Sie auf das Drei-Punkte-Symbol neben dem Schlüssel.
- Wählen Sie Erneut senden. Der API-Schlüssel wird an die E-Mail-Adresse gesendet, die bei der Erstellung des Schlüssels angegeben wurde.
Klonen eines API-Schlüssels
So klonen Sie einen API-Schlüssel:
- Klicken Sie auf das Drei-Punkte-Symbol neben dem Schlüssel und wählen Sie Klonen.
- Aktualisieren Sie bei Bedarf den Namen, die Berechtigungen oder das Ablaufdatum.
- Folgen Sie dem gleichen Prozess zum Generieren oder Senden des Schlüssels wie im Abschnitt „Erstellen eines neuen API-Schlüssels.“ beschrieben.
Anzeigen archivierter Schlüssel
Um widerrufene oder archivierte API-Schlüssel anzuzeigen, navigieren Sie zum Tab Archiviert in den API-Schlüssel-Einstellungen. Widerrufene Schlüssel können nicht wiederhergestellt werden, aber sie können geklont werden, um eine Kopie zu erstellen.
Übergang von klassischen API-Schlüsseln
Obwohl klassische API-Schlüssel vorerst weiterhin funktionieren, empfehlen wir die Migration zum neuen System für verbesserte Sicherheit und bessere Kontrolle über Ihre Integrationen.
Finden Ihres klassischen API-Schlüssels
Ihr klassischer API-Schlüssel wurde von Admin > Einstellungen > Erweiterte Einstellungen zur neuen Seite für die API-Schlüssel-Verwaltung verschoben. Sie finden ihn jetzt am unteren Rand der API-Einstellungsseite (Admin > Einstellungen > API-Schlüssel).
So migrieren Sie von klassischen API-Schlüsseln
Um sicher von Ihrem klassischen API-Schlüssel zu wechseln:
- Erstellen Sie neue berechtigte Schlüssel: Generieren Sie separate API-Schlüssel für jede Integration mit den Schritten im Abschnitt „Erstellen eines neuen API-Schlüssels“ oben. Stellen Sie sicher, dass jeder Schlüssel nur die spezifischen Berechtigungen für seine Integration hat.
- Aktualisieren Sie Ihre Integrationen: Ersetzen Sie den klassischen API-Schlüssel in jeder Integration durch den entsprechenden neuen berechtigten Schlüssel.
- Löschen Sie Ihren klassischen API-Schlüssel: Sobald alle Integrationen aktualisiert sind, klicken Sie auf der API-Einstellungsseite unten auf die Schaltfläche „Klassischen API-Schlüssel löschen“.
Erforderliche Berechtigungen für Integrationen
Eine Liste von Integrationen, die API-Schlüssel verwenden, und die jeweils erforderliche Berechtigung:
- ScreenCloud – Custom Feed
- Qualtrics – Externe Anerkennung
- Speakap – Social Feed
- Sworkit – Massenbelohnung
- Paycom – Benutzer importieren
- Awardco Connect (für alle Kunden) – Ein Awardco-Vertreter wird Sie bezüglich der spezifischen Berechtigungen für Ihren API-Schlüssel beraten. In den meisten Fällen sind nur wenige Berechtigungen erforderlich.
If you have any questions, please contact Awardco Admin Support.