Documentation/Developers
Back
  • Getting started
    • Frontends and app types
    • Environments and endpoints
  • OAuth clients
    • Client ID and secret
    • Redirect URIs and start URL
    • Secret rotation
  • Login with appsolut
    • Authorization code flow
    • Tokens and claims
    • Frontend role
    • Sign-out
    • Revocation and issued tokens
    • Token endpoint errors
  • Frontend keys
    • Issue and store a key
    • Send a key
    • Rotate and revoke
  • Members API
    • Eligibility from a backend
    • The signed-in member
    • Results, rate limits and errors
    • Is an applicant an eligible member?
    • The signed-in frontend user's membership
  • appsolut register API
    • Implement the API
    • Connect and test
    • Verify a member with their challenge code
    • List every member
    • The status of several members
    • The status of one member
    • The person data of several members
    • The person data of one member
    • The claims of several members
    • The claims of one member
    • Health check

Getting started

What a developer builds against appsolut ONE, and where to begin.

appsolut ONE is the enterprise community server. Its Studio is where an organisation decides who its members are and which apps they may use; its Community Portal is a website the organisation connects to the Studio. These pages are for whoever builds against the Studio: a frontend, the frontend's backend, or an external register.

Three ways to connect

You buildYou useSection
A website or app that people sign in toLogin with appsolut: OAuth 2.1 and OpenID Connect, with the frontend's OAuth clientOAuth clients, Login with appsolut
The backend of that website or app, asking about membersThe Members API, with a frontend keyFrontend keys, Members API
An external register: your organisation's own member list, such as the HR system, that the Studio asks liveThe appsolut register API, which your register exposesappsolut register API

A frontend usually needs the first two: its users sign in with Login with appsolut, and its backend calls the Members API for what the token does not say, such as whether someone who is not signed in is a member. The appsolut register API runs the other way: the Studio calls your register.

An example

The examples in these pages use Pannoniqa AG, a fictional manufacturer. Pannoniqa connects its HR system as the external register "SAP HR" for active employees and keeps the internal registers "Retirees" and "Works council" in the Studio. Its communities are "Active employees", "Retirees" and "All staff". The "Pannoniqa Portal", a Community Portal, serves all staff; the mobile "Pannoniqa App" serves active employees only.

In this section

  • Frontends and app types: what a frontend is from a developer's view, and what the organisation gives you for it.
  • Environments and endpoints: the two origins you work with, and where each API lives.

The terms these pages use are the Studio's own; the Studio manual's key concepts explain them.