appsolut Register-API
Die API, die ein externes Register bereitstellt, damit das Studio es zu Mitgliedsnummern befragen kann.
Ein externes Register ist eine Liste von Personen, die Mitglied werden können, und bleibt im eigenen System der Organisation, etwa Pannoniqas Personalsystem „SAP HR“. Das Studio kopiert es nicht: Es fragt es über die appsolut Register-API live ab, wann immer es etwas über eine Mitgliedsnummer wissen muss. Dieser Abschnitt ist für alle, die diese API vor dem System der Organisation bauen.
Wie das Studio sie verwendet
| Wann | Das Studio ruft auf | Mit |
|---|---|---|
| Eine Person durchläuft das Onboarding, und in der Anbindung ist „Prüfcode erforderlich“ eingeschaltet | Ein Mitglied mit seinem Prüfcode verifizieren | Der Mitgliedsnummer wie eingegeben, dem eingegebenen Geburtsdatum und dem Prüfcode |
| Eine Person durchläuft das Onboarding ohne Prüfcode, oder ein Frontend fragt nach einem Antragsteller (Berechtigung) | Die Personendaten eines Mitglieds | Der Mitgliedsnummer wie eingegeben |
| Ein Mitglied meldet sich an (Anmeldeprüfung) | Der Status eines Mitglieds | Der gespeicherten Mitgliedsnummer |
| In jedem dieser Fälle, wenn die Mitgliedschaftsdefinition oder eine Community nach einem Claim filtert | Stattdessen Die Claims eines Mitglieds | Derselben Mitgliedsnummer |
| Ein Frontend liest die Mitgliedsdaten des angemeldeten Mitglieds | Die Personendaten eines Mitglieds, mit einer Frist von 1,5 Sekunden | Der gespeicherten Mitgliedsnummer |
| Ein Studio-Benutzer testet die Verbindung | Health-Check, Die Personendaten eines Mitglieds für eine Test-Mitgliedsnummer und einmal Alle Mitglieder auflisten | – |
Wo das Studio Angaben vergleicht (Onboarding und Berechtigung), vergleicht es Vorname, Nachname und Geburtsdatum in Ihrer Antwort mit den Eingaben der Person. Das Register entscheidet, ob es eine Person gibt und welchen Status und welche Claims sie hat; die Mitgliedschaftsdefinition der Organisation entscheidet, was das bedeutet.
Die Operationen Der Status mehrerer Mitglieder, Die Personendaten mehrerer Mitglieder und Die Claims mehrerer Mitglieder gehören zum Standard, aber das Studio ruft sie derzeit nicht auf.
Was jeder Aufruf mitbringt
| Header | Wert |
|---|---|
x-api-key | Der „API-Schlüssel“, der in der Anbindung des Registers im Studio eingetragen ist |
x-tenant-id | Die dort eingetragene „Mandanten-ID“, damit ein Register mehrere Organisationen bedienen kann |
x-custom-scope | Der dort eingetragene „Scope“, um einen Datenbestand zu wählen |
accept | application/json |
In diesem Abschnitt
- Die API umsetzen: die Antworten, die das Studio erwartet, und seine Netzwerkregeln.
- Anbinden und testen: die Anbindung im Studio eintragen und testen.
- Die Referenz: jede Operation, erzeugt aus der OpenAPI-Beschreibung, beginnend mit Ein Mitglied mit seinem Prüfcode verifizieren.