Die API umsetzen
Die Antworten, die das Studio von einem externen Register erwartet, und seine Netzwerkregeln.
Was umzusetzen ist
| Operation | Pfad | Gebraucht |
|---|---|---|
| Health-Check | GET /health | Immer: Der Verbindungstest ruft ihn zuerst auf |
| Der Status eines Mitglieds | GET /members/status/{memberCode} | Immer: jede Anmeldeprüfung |
| Die Personendaten eines Mitglieds | GET /members/data/{memberCode} | Immer: Onboarding, Berechtigung, Mitgliedsdaten, Verbindungstest |
| Die Claims eines Mitglieds | GET /members/claims/{memberCode} | Wenn die Organisation nach Claims filtert |
| Ein Mitglied mit seinem Prüfcode verifizieren | POST /members/verify | Wenn in der Anbindung „Prüfcode erforderlich“ eingeschaltet ist |
| Alle Mitglieder auflisten | GET /members | Optional: Antworten Sie mit 501, wenn Sie es nicht anbieten |
Die Pfade werden an die im Studio eingetragene Basis-URL angehängt: Mit der Basis-URL https://register.pannoniqa.example/api ruft eine Anmeldeprüfung https://register.pannoniqa.example/api/members/status/100001 auf.
Antworten
- JSON mit einem Status 2xx, passend zur Referenz. Felder, die das Studio nicht kennt, werden ignoriert; ein bekanntes Feld mit falschem Typ macht die Antwort unbrauchbar.
- Nicht gefunden ist
404bei den Operationen für ein Mitglied. „Ein Mitglied mit seinem Prüfcode verifizieren“ antwortet nie mit 404, sondern mit200undverified: false, auch bei einer unbekannten Mitgliedsnummer. - Personendaten: Wo das Studio Angaben vergleicht, braucht ein gefundenes Mitglied
firstName,lastNameundbirthDateinparams. Fehlen sie, behandelt das Studio das Register als nicht erreichbar, nie als Bestehen allein auf Grund der Mitgliedsnummer. Namen werden ohne Rücksicht auf Groß- und Kleinschreibung, Akzente und zusätzliche Leerzeichen verglichen (ä, ö, ü und ß gelten als ae, oe, ue und ss); das Geburtsdatum nach seinen ersten zehn Zeichen,JJJJ-MM-TT. - Status:
active,inactiveoderpending. Die Filter der Organisation entscheiden, was jeder bedeutet, etwa ob Personen in „SAP HR“, dieinactivesind, noch als Mitglieder zählen. - Claims sind optionale Angaben, nach denen die Organisation filtern kann, etwa
employeeGroupoderleavingDate. Sie dürfen über die Standard-Claims hinaus eigene senden. - Mitgliedsdaten: Die Anschrift in
params(street,zip,city) darf ein Frontend seinem angemeldeten Mitglied anzeigen. Senden Sie keine Telefonnummer: Der Standard kennt keine. - Die Mitgliedsnummer kommt URL-codiert als ein Pfadsegment an. Vergleichen Sie sie so, wie Ihr System Personen führt.
Was das Studio aus anderen Antworten macht
| Antwort | Das Studio behandelt das Register als |
|---|---|
401 oder 403 | Nicht erreichbar, mit abgelehnten Zugangsdaten |
501 auf „Alle Mitglieder auflisten“ | Unterstützt diese Operation nicht |
| Jeder andere Status außerhalb von 2xx | Nicht erreichbar |
| Keine Antwort innerhalb von 5 Sekunden (1,5 Sekunden für Mitgliedsdaten) | Nicht erreichbar |
| Ein Inhalt, der kein JSON ist, den Vertrag verletzt oder größer als 4 MB ist | Nicht erreichbar |
Ein nicht erreichbares Register macht die Mitgliedschaftsprüfung unavailable, nie not_valid: Das Onboarding wartet, und Mitglieder, deren letzte gültige Prüfung weniger als 7 Tage alt ist, melden sich mit diesem Ergebnis weiter an (die Kulanzregel).
Netzwerkregeln
- Nur HTTPS, auf einer öffentlichen Adresse. Das Studio weist private und reservierte Adressen ab, und einfaches
httpist nur fürlocalhostoder127.0.0.1in einer lokalen Testumgebung erlaubt, nie in der Produktion. - Weiterleitungen werden nur auf demselben Ursprung befolgt, höchstens 3. Eine Weiterleitung an einen anderen Host wird abgewiesen.
- Keine Zugangsdaten, keine Query und kein Fragment in der Basis-URL.