Die Custom Feed API ermöglicht es Ihnen, Mitarbeiteranerkennungsfeeds nach Metadaten zu filtern, Empfängern Labels hinzuzufügen und die Anzeige der Anerkennungen anzupassen. Sie wird häufig mit ScreenCloud verwendet, kann aber auch unabhängig eingerichtet werden. Für die Integration mit ScreenCloud siehe diesen Artikel.
Für Kunden, die die Custom Feed API direkt einrichten, finden Sie hier eine Schritt-für-Schritt-Anleitung zur Konfiguration.
- Zugriff auf API-Einstellungen
- Filterfeld konfigurieren (In der Plattform)
- Metadaten-Labels auswählen (optional)
- Fehlermeldungen aktivieren
- API konfigurieren (Metadatenfilter)
- Testen und Fehlerbehebung
- Hilfreiche Ressourcen
Zugriff auf API-Einstellungen
Um mit der Custom Feed API zu beginnen, melden Sie sich im Awardco Admin-Portal an und greifen Sie auf die erforderlichen Konfigurationseinstellungen zu.
- Melden Sie sich bei Ihrem Awardco-Konto an.
- Wählen Sie die Schaltfläche „Admin“ unten im linken Navigationsmenü aus.
- Wählen Sie im linken Navigationsmenü „Plattform“, dann „Integrationen“ und anschließend „API-Einstellungen“ aus.
- Klicken Sie auf den Tab „API-Konfiguration“.
Dies öffnet die Seite, auf der Sie sowohl die In-Plattform-Einstellungen als auch die API-Konfiguration für Ihren Custom Feed vornehmen können.
Filterfeld konfigurieren (In der Plattform)
Das Filterfeld ermöglicht es Ihnen zu steuern, wie Anerkennungen basierend auf Metadatenfeldern gefiltert werden, wie z. B. Standort, Abteilung oder einer anderen für Ihre Organisation relevanten Kategorie. Dieser Filter stellt sicher, dass nur die Anerkennungen angezeigt werden, die bestimmten Kriterien entsprechen. So konfigurieren Sie das Filterfeld:
- Wählen Sie ein Metadatenfeld, das als Filter fungiert. Wenn Ihr Unternehmen beispielsweise mehrere Bürostandorte hat, könnten Sie das Metadatenfeld „Standort“ verwenden.
- Klicken Sie auf „Änderungen speichern“.
Beispiel:
Für ein Unternehmen mit Büros in verschiedenen Städten ermöglicht die Auswahl von Standort als Filter die Anzeige von Anerkennungen basierend auf bestimmten Standorten wie „London“ oder „New York“.
Hinweis: Das Filterfeld gibt das Metadatenfeld an (z. B. „Standort“), die Werte, nach denen gefiltert wird, definieren Sie später in der API selbst.
Metadaten-Labels auswählen (optional)
Sie können den Anerkennungsfeed verbessern, indem Sie zusätzliche Metadaten anzeigen, wie z. B. Abteilung oder Berufsbezeichnung für jeden anerkannten Mitarbeiter. So konfigurieren Sie Metadaten-Labels:
- Wählen Sie unter Sublabel 1 und Sublabel 2 die Metadatenfelder aus, die Sie anzeigen möchten. Häufige Beispiele sind Abteilung und Berufsbezeichnung.
- Zum Beispiel könnten durch die Auswahl von Abteilung und Berufsbezeichnung Details wie „Vertrieb“ und „Account Executive“ angezeigt werden.
Dieser Schritt ist optional, kann aber zusätzlichen Kontext für Ihren Anerkennungsfeed bieten.
Fehlermeldungen aktivieren
Um einen reibungslosen Ablauf Ihrer Einrichtung sicherzustellen, empfehlen wir, Fehlermails zu aktivieren. Diese Funktion benachrichtigt Sie, wenn es Probleme mit dem Custom Feed gibt, wie z. B. ungültige Konfigurationen oder fehlende Metadaten.
- Suchen Sie in den Einstellungen die Option „Fehlermails senden“.
- Aktivieren Sie diese Funktion, um Fehlerbenachrichtigungen zu erhalten.
Sie können Fehlermails vorübergehend deaktivieren, wenn Ihnen bekannte Probleme bekannt sind, die gerade behoben werden.
API konfigurieren (Metadatenfilter)
Nachdem die In-Plattform-Einstellungen konfiguriert sind, müssen Sie die spezifischen Werte für die Filterung mit dem Request-Parameter metadataFilter in API-Aufrufen definieren.
- Die In-Plattform-Einstellung für den Metadatenfilter legt fest, welches Feld für die Filterung verwendet wird (z. B. Standort).
- Der API-Parameter metadataFilter gibt an, welcher Wert in diesem Feld als Filterkriterium verwendet werden soll (z. B. nur Anerkennungen anzeigen, bei denen „Standort“ = „Las Vegas“ auf diesem Bildschirm).
So konfigurieren Sie die API:
- Verwenden Sie in der API-Konfiguration den Request-Parameter metadataFilter, um Werte für die Filterung anzugeben.
- Stellen Sie sicher, dass der Wert mit den Metadatenwerten in Ihren Benutzerdaten übereinstimmt.
Beispiel für einen API-Aufruf:
https://api.awardco.com/api/feed?metadataFilter=Location:London
Dies stellt sicher, dass nur Anerkennungen angezeigt werden, die mit der Metadaten-Location „London“ gekennzeichnet sind. Wenn Metadatenfelder geändert oder entfernt werden, müssen Sie die Filterkonfiguration entsprechend aktualisieren.
Testen und Fehlerbehebung
Nachdem Sie die Einrichtung abgeschlossen haben, ist es wichtig, den Feed zu testen, um sicherzustellen, dass alles korrekt angezeigt wird.
- Überprüfen Sie, ob der Filter korrekt angewendet wird und die richtigen Anerkennungen basierend auf Ihren Einstellungen angezeigt werden.
- Wenn Sie Probleme feststellen, überprüfen Sie Ihre Fehlermail-Benachrichtigungen für weitere Details.
Hilfreiche Ressourcen
Zur Unterstützung bei der Einrichtung und für detailliertere Anleitungen finden Sie hier einige hilfreiche Ressourcen:
- API-Dokumentation: Vollständige Anleitung zur Nutzung der Custom Feed API mit Parametern und Beispielen.
- Awardco API-Ressourcen: API-Dokumentation und Support.
If you have any questions, please contact Awardco Admin Support.