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

Frontends und App-Typen

Was ein Frontend aus Sicht der Entwicklung ist und was Sie dafür von der Organisation bekommen.

Ein Frontend ist eine App, bei der sich die Menschen einer Organisation mit Login with appsolut anmelden. Im Studio ist jedes Frontend ein Eintrag unter „Frontends“, und jedes Frontend ist genau ein OAuth-Client.

Was bestimmt, wie ein Frontend funktioniert

Die Organisation legt das auf der Seite des Frontends im Studio fest:

  • Art: „Intern“ (eine eigene Website oder mobile App der Organisation) oder „Extern“ (eine App eines Dritten, die die Organisation anbindet). Die Art wird beim Anlegen festgelegt.
  • Community: Genau eine Community bedient das Frontend und entscheidet, welche Mitglieder es nutzen dürfen. Beim Pannoniqa Portal sind das „Gesamte Belegschaft“, bei der Pannoniqa App „Aktive Belegschaft“.
  • Mitgliedschaft verpflichtend: standardmäßig eingeschaltet. Dann erhalten nur gültige Mitglieder der Community des Frontends ein Token; ohne diese Einstellung kann sich jeder mit einem Konto anmelden, und das Token sagt, ob er Mitglied ist.
  • App-Typ: welche Art von App das Frontend ist. Er entscheidet, ob das Frontend ein Client-Secret aufbewahren kann und welche Redirect-URIs es verwenden darf.
App-TypIm StudioWas es ist
web„Web-App“Eine Website mit eigenem Backend, das das Client-Secret aufbewahrt
spa„Single-Page-App“Eine App, die nur im Browser läuft, ohne Backend
mobile„Mobile App“Eine App für iOS oder Android
desktop„Desktop-App“Eine auf einem Computer installierte App
server„Server“Ein Dienst, der sich ohne Benutzer anmeldet

Derzeit können nur interne Web-Apps Benutzer anmelden. Das Studio zeigt die anderen App-Typen als „Später“, und die Karte „Anmeldung“ eines externen Frontends sagt, dass die Anmeldung für externe Frontends im Dezember folgt. Eine Web-App ist ein vertraulicher OAuth-Client: Sie bewahrt ihr Client-Secret und die Tokens ihrer Benutzer auf ihrem eigenen Server auf.

Was Sie von der Organisation bekommen

Ein Studio-Benutzer, der Frontends verwalten darf (die Studio-Rollen „Eigentümer“, „Administrator“ und „Frontend-Manager“), richtet das Frontend ein und übergibt Ihnen:

WasWoherWofür
Client-IDDie Karte „Anmeldung“ des FrontendsLogin with appsolut
Client-SecretEinmal angezeigt, wenn der Anmelde-Client erstellt oder das Secret erneuert wirdCodes gegen Tokens eintauschen
Frontend-SchlüsselEinmal angezeigt, wenn auf der Karte „Schlüssel“ des Frontends ein Schlüssel ausgestellt wirdDie Mitglieder-API aufrufen
Die ID der OrganisationBei appsolut erfragen, mit der Client-ID; das Studio zeigt sie noch nicht antenant_id in Tokens prüfen

Von Ihnen braucht die Organisation die Redirect-URIs und die Start-URL des Frontends: siehe Redirect-URIs und Start-URL.

Client-Secret und Frontend-Schlüssel sind verschiedene Geheimnisse für verschiedene Aufrufe: das Secret nur für den Token-Endpunkt, der Schlüssel nur für die Mitglieder-API. Verwenden Sie nie das eine an Stelle des anderen.

Ein abgeschaltetes Frontend

Eine Organisation kann ein Frontend trennen („Frontend trennen“). Ab dann meldet es niemanden mehr an, jede seiner Anmeldesitzungen endet, und seine Frontend-Schlüssel werden abgewiesen. Seine Einstellungen, Schlüssel und sein Anmelde-Client bleiben erhalten; wird es wieder verbunden, funktioniert beides wieder, und wer abgemeldet wurde, meldet sich erneut an. Siehe Widerruf.