Weitere Anleitungen zu diesem Thema:

Sync-API: Asynchrone Fehlerbehandlung

Sync-API: Interaktionen einschränken

Sync-API: Häufige Probleme

Die Bereiche der Sync-API sind wie folgt:

1. Erstellen, Lesen, Aktualisieren und Löschen (CRUD) von Benutzerinformationen
2. Erstellen, Lesen, Aktualisieren und Löschen (CRUD) von Channelinformationen
3. Erstellen, Lesen, Aktualisieren und Löschen (CRUD) von Channelmitgliedschaften und Channelrollen für Benutzer
4. Erstellen, Lesen, Aktualisieren und Löschen (CRUD) von Tag-Regeln zur Einschränkung der Interaktionen zwischen Benutzern
5. Lesen des Zustands und der Fehler asynchroner Anfragen

Im ersten Schritt bitte deinen Ansprechpartner bei Flip, eine API-Client-Konfiguration für dich zu erstellen. Du erhältst dann alle Informationen, die du benötigst, um mit dieser API zu arbeiten.

Die Flip Sync-API ermöglicht es dir, deine Flip-Instanz automatisiert mit Benutzern und Channels zu füllen. Du musst einen Connector zwischen deiner bestehenden Datenquelle und der Flip Sync-API erstellen, um eine nahtlose Daten-Synchronisation zwischen den beiden Systemen zu ermöglichen.

Wichtige Aspekte vor der Implementierung

Es ist wichtig, über bestimmte Dinge nachzudenken, da sie direkt die Benutzererfahrung beeinflussen.

Wenn sich Mitarbeiter mit einem Benutzernamen und Passwort einloggen müssen, benötigen sie einen Benutzernamen, der leicht zu merken und einzigartig ist. Wie der Benutzername aussieht, liegt bei dir. Hier sind drei häufige Anwendungsfälle:

• In Fällen, in denen jeder Benutzer eine bekannte E-Mail-Adresse hat, wird diese als Benutzername verwendet, da dies die Einzigartigkeit gewährleistet.
• In anderen Fällen wird ein Benutzername mit dem Muster „vorname.nachname“ verwendet. Da die Einzigartigkeit bei einer großen Mitarbeiterbasis nicht garantiert werden kann, wird oft eine Nummer hinzugefügt: „vorname.nachname2“.
• Wenn die Mitarbeiter ihre Personalnummer aus dem Quell-HR-System kennen, ist es auch möglich, diese als Benutzernamen zu verwenden.

Eine weitere wichtige Entscheidung ist, ob ein Mitarbeiter den Nutzungsbedingungen zustimmen muss, bevor er die App regelmäßig verwendet. Diese Information kann jedem einzelnen Benutzer über die API bereitgestellt werden. Du hast die folgenden Optionen:

• Nicht fragen, was derzeit der Standard ist.
• Beim nächsten Login fragen.
• Beim ersten Login fragen.

Im Allgemeinen empfehlen wir, jedes Attribut zu prüfen, das über die API übermittelt werden kann, und vor der Implementierung Entscheidungen zu treffen.

Sync-API-Spezifikation

Unsere API-Spezifikation findest du unter dem nachfolgenden Link. Um dich mit den Spezifikationen vertraut zu machen, empfehlen wir, die API mit Postman, Insomnia oder einem ähnlichen Tool zu testen.

Bitte beachte, dass „Gruppen“ in der Dokumentation „Channel“ bedeutet. Dies liegt daran, dass die entsprechende Funktionalität nach der Veröffentlichung der API umbenannt wurde.

Flip-API-Dokumentation

Vorgeschlagene Implementierungsstrategien

Delta-Verarbeitung von Daten, Abfragen der asynchronen Anfrage-Endpunkte und Queuing sind drei Mechanismen, die wir dir zur Implementierung in eurem Connector empfehlen.

Effiziente Daten-Synchronisation mit Delta-Verarbeitung

Überlege, nur Updates an die Flip Sync-API für die tägliche Daten-Synchronisation zu senden. Dies reduziert das Datenvolumen erheblich und verbessert die Leistung eures Connectors und der Flip-Anwendung. Erreiche dies, indem du einen Delta-Verarbeitungsmechanismus erstellst, der deine Datenquelle mit den Flip-Daten vergleicht. Nur die Differenz, oder das „Delta“, muss an die Sync-API gesendet werden.

Verfolgen asynchroner API-Antworten

Die Flip Sync-API ist asynchron, was bedeutet, dass sie nicht für jede Anfrage Erfolg oder Misserfolg bestätigt. Stattdessen bestätigt sie einfach den Erhalt mit dem Antwortcode 202. Du musst die asynchronen Anfrage-Endpunkte abfragen, um mögliche Fehler bei deinen Datenaktualisierungen zu identifizieren. Sieh dir unsere Spezifikationen für eine detaillierte Beschreibung an. Euer Connector sollte automatisch Anfragen an diese Endpunkte senden, um die Fehlerverfolgung zu vereinfachen und wertvolles Feedback zu möglichen Problemen mit den Daten zu liefern.

Zuverlässige Datenübermittlung mit Queuing

Implementiere einen Queuing-Mechanismus, der Daten in Chargen an die Sync-API sendet. Diese Warteschlange bearbeitet Datenblöcke, indem sie diese einzeln sendet. Daten werden nur bei erfolgreichen Ereignissen wie dem Erwerb eines Anfrage-Tokens aus der Warteschlange freigegeben. Wenn nach dem Senden von Daten ein Fehler auftritt, wird der betroffene Benutzer oder Kanal automatisch in eine separate Fehler- oder Sekundärwarteschlange geleitet. Dies, zusammen mit dem Abfragen der asynchronen Anfrage-Endpunkte, ermöglicht es, den Überblick über alle an Flip gesendeten Daten zu behalten. Es gibt einen vollständigen Überblick über mögliche Probleme und stellt sicher, dass Daten erfolgreich gesendet werden.

Durch die Implementierung dieser Mechanismen wird dein Flip-Connector zu einer effektiveren und zuverlässigeren Datenbrücke, die den Datentransfer zwischen deinem System und Flip optimiert.