Contact Support

Einrichtung der Custom Feed API (Legacy)

Aktualisiert

This is a Legacy article. If you are using the current Awardco 2.0 Interface, please search for the updated version to ensure accuracy.

Die Custom Feed API ermöglicht es Ihnen, Mitarbeiteranerkennungsfeeds basierend auf Metadaten zu filtern, zusätzliche Labels für Empfänger anzuzeigen und die Darstellung der Anerkennungen anzupassen. Obwohl die Custom Feed API häufig mit ScreenCloud verwendet wird, können Sie sie auch unabhängig einrichten, um den individuellen Anforderungen Ihrer Organisation gerecht zu werden. Wenn Sie eine Integration mit ScreenCloud wünschen, können Sie den Schritten in diesem Artikel folgen.

 

Für Kunden, die die Custom Feed API direkt einrichten, finden Sie hier eine Schritt-für-Schritt-Anleitung zur Konfiguration.

 

  1. API-Einstellungen aufrufen
  2. Filterfeld konfigurieren (In-Plattform)
  3. Metadaten-Labels auswählen (Optional)
  4. Fehlerbenachrichtigungen aktivieren
  5. API konfigurieren (Metadaten-Filter) 
  6. Testen und Fehlerbehebung
  7. Hilfreiche Ressourcen

 

API-Einstellungen aufrufen

Um mit der Custom Feed API zu beginnen, melden Sie sich im Awardco Admin Portal an und rufen die notwendigen Konfigurationseinstellungen auf.

  1. Melden Sie sich im Awardco Admin Portal an.
  2. Navigieren Sie zu den Admin-Einstellungen.
  3. Wählen Sie API-Einstellungen aus.
  4. 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-Plattform)

Das Filterfeld ermöglicht es Ihnen, Anerkennungen basierend auf Metadatenfeldern wie Standort, Abteilung oder einer anderen für Ihre Organisation relevanten Kategorie zu filtern. Dieser Filter stellt sicher, dass nur Anerkennungen angezeigt werden, die bestimmten Kriterien entsprechen. Um das Filterfeld zu konfigurieren:

  1. Wählen Sie ein Metadatenfeld aus, das als Filter fungiert. Wenn Ihr Unternehmen beispielsweise mehrere Bürostandorte hat, könnten Sie das Metadatenfeld Standort verwenden.
  2. Klicken Sie auf „Änderungen speichern“.

 

Beispiel:

Für ein Unternehmen mit Büros in verschiedenen Städten ermöglicht die Auswahl des Standorts als Filter, Anerkennungen basierend auf bestimmten Standorten wie „London“ oder „New York“ anzuzeigen.

 

Hinweis: Das Filterfeld legt fest, welches Metadatenfeld (z. B. „Standort“) verwendet wird. Die Werte, nach denen gefiltert wird, definieren Sie später in der API selbst.

Metadaten-Labels auswählen (Optional)

Sie können den Anerkennungsfeed erweitern, indem Sie zusätzliche Metadaten anzeigen, wie z. B. Abteilung oder Berufsbezeichnung für jeden anerkannten Mitarbeiter. Um Metadaten-Labels zu konfigurieren:

  1. Wählen Sie unter Sublabel 1 und Sublabel 2 die Metadatenfelder aus, die Sie anzeigen möchten. Häufige Beispiele sind Abteilung und Berufsbezeichnung.
  2. Zum Beispiel könnten durch die Auswahl von Abteilung und Berufsbezeichnung Details wie „Vertrieb“ und „Account Executive“ angezeigt werden.

 

Dieser Schritt ist optional, kann jedoch zusätzlichen Kontext für Ihren Anerkennungsfeed bieten.

 

Fehlerbenachrichtigungen aktivieren

Um einen reibungslosen Ablauf Ihrer Einrichtung zu gewährleisten, empfehlen wir, Fehler-E-Mails zu aktivieren. Diese Funktion benachrichtigt Sie, falls es Probleme mit dem Custom Feed gibt, wie ungültige Konfigurationen oder fehlende Metadaten.

  1. Suchen Sie die Option „Fehler-E-Mails senden“ in den Einstellungen.
  2. Aktivieren Sie diese Funktion, um Fehlerbenachrichtigungen zu erhalten.

 

Sie können Fehler-E-Mails vorübergehend deaktivieren, wenn Ihnen bekannte Probleme bekannt sind, die gerade behoben werden.

 

API konfigurieren (Metadaten-Filter)

Nachdem die In-Plattform-Einstellungen konfiguriert sind, müssen Sie die spezifischen Werte für die Filterung mithilfe des Request-Parameters metadataFilter in API-Aufrufen definieren.

  • Die In-Plattform-Einstellung Metadata Filter bestimmt, welches Feld für die Filterung verwendet wird (z. B. Standort).
  • Der API-Parameter metadataFilter gibt an, welcher Wert in diesem Feld als Filterkriterium dient (z. B. werden auf diesem Bildschirm nur Anerkennungen angezeigt, bei denen „Standort“ = „Las Vegas“ ist).

 

So konfigurieren Sie die API:

  1. Verwenden Sie im API-Setup den Request-Parameter metadataFilter, um Werte für die Filterung anzugeben.
  2. Stellen Sie sicher, dass der Wert mit den in Ihren Benutzerdaten gespeicherten Metadatenwerten ü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 dem Metadaten-Standort 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 Probleme auftreten, prüfen Sie Ihre Fehler-E-Mail-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 Dokumentation zur Verwendung der Custom Feed API, einschließlich verfügbarer Parameter und Beispiele.
  • Awardco API-Ressourcen: Allgemeine API-Dokumentation und zusätzliche Unterstützung.



 

If you have any questions, please contact Awardco Admin Support.

Verknüpfung mit