Dokumentation/Entwickler
Zurück
  • Erste Schritte
    • Frontends und App-Typen
    • Umgebungen und Endpunkte
  • OAuth-Clients
    • Client-ID und Client-Secret
    • Redirect-URIs und Start-URL
    • Secret erneuern
  • Login with appsolut
    • Authorization-Code-Flow
    • Tokens und Claims
    • Frontend-Rolle
    • Abmeldung
    • Widerruf und ausgestellte Tokens
    • Fehler des Token-Endpunkts
  • Frontend-Schlüssel
    • Einen Schlüssel ausstellen und aufbewahren
    • Einen Schlüssel senden
    • Wechseln und widerrufen
  • Mitglieder-API
    • Berechtigung aus einem Backend
    • Das angemeldete Mitglied
    • Ergebnisse, Ratenlimits und Fehler
    • Ist ein Antragsteller ein berechtigtes Mitglied?
    • Die Mitgliedschaft des angemeldeten Frontend-Benutzers
  • appsolut Register-API
    • Die API umsetzen
    • Anbinden und testen
    • Ein Mitglied mit seinem Prüfcode verifizieren
    • Alle Mitglieder auflisten
    • Der Status mehrerer Mitglieder
    • Der Status eines Mitglieds
    • Die Personendaten mehrerer Mitglieder
    • Die Personendaten eines Mitglieds
    • Die Claims mehrerer Mitglieder
    • Die Claims eines Mitglieds
    • Health-Check

Umgebungen und Endpunkte

Die zwei Ursprünge, mit denen ein Frontend arbeitet, und wo welche API liegt.

Ein Frontend spricht mit zwei Ursprüngen. appsolut gibt Ihnen beide, zusammen mit dem Publishable Key des Projekts, für jede Umgebung, in der Sie arbeiten (etwa eine Testumgebung und die Produktion):

  • <auth>: die Auth-API des Studio-Projekts, https://<API-Host des Projekts>/auth/v1. Dort läuft der OAuth-2.1-Server: Autorisierung, Tokens und die Schlüssel, um sie zu prüfen.
  • <studio>: der Ursprung des Studios. Es stellt die Anmeldeseiten unter /oauth/* und die Mitglieder-API unter /api/v1 bereit.

Bei einem externen Register ist es umgekehrt: Das Studio ruft die Basis-URL auf, die Ihr Register bereitstellt.

Wo welche API liegt

WasEndpunktAufgerufen von
OIDC-DiscoveryGET <auth>/.well-known/openid-configurationIhrem Backend, einmal
AutorisierungGET <auth>/oauth/authorizedem Browser, von Ihrer App dorthin weitergeleitet
Anmeldeseiten<studio>/oauth/authorize?authorization_id=…dem Browser, von <auth> dorthin weitergeleitet; rufen Sie sie nie selbst auf
TokenPOST <auth>/oauth/tokenIhrem Backend
UserInfoGET <auth>/oauth/userinfoIhrem Backend; antwortet nur mit sub, Sie brauchen ihn also selten
JWKSGET <auth>/.well-known/jwks.jsonIhrem Backend, um Tokens zu prüfen
Abmeldeseite<studio>/oauth/sign-out?client_id=<Ihre Client-ID>dem Browser
Mitglieder-API<studio>/api/v1/members/...Ihrem Backend, mit seinem Frontend-Schlüssel
appsolut Register-APIdie Basis-URL Ihres Registersdem Studio

Senden Sie bei Aufrufen Ihres Backends an <auth> den Publishable Key als Header apikey.

Lokale Entwicklung

Redirect-URIs und die Start-URL dürfen http://localhost oder http://127.0.0.1 mit beliebigem Port verwenden, sodass sich ein Frontend auf Ihrem Rechner gegen eine Testumgebung anmelden kann. Alles andere braucht https.

Nur von Server zu Server

Die Mitglieder-API beantwortet kein CORS, und die Tokens von Login with appsolut gehören auf Ihren Server: Geben Sie das Zugriffs- oder Refresh-Token, das Client-Secret oder einen Frontend-Schlüssel nie an den Browser weiter.