Skip to main content
Version: Next

Developer Quickstart

Get started with the Lana APIs in minutes.

Prerequisites​

  • API credentials provided by your Lana administrator
  • A GraphQL client (curl, Postman, or a language-specific client library)
  • Your Lana instance URL (e.g., https://admin.your-instance.com)

Step 1: Obtain an Authentication Token​

Lana uses Keycloak OAuth 2.0 / OpenID Connect. Ask your administrator for the instance's realm, client configuration, and a provisioned Lana user. Use an OIDC client with the Authorization Code Flow and PKCE to obtain an access_token; see Authentication.

For local development, start the app and obtain a token using the local admin token example.

The admin API requires a token with a userId claim linked to a Lana user. A generic client-credentials token is not sufficient, and the realm is not necessarily named admin.

Step 2: Make Your First Query​

curl -X POST \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ me { user { userId email } } }"}' \
  https://admin.your-instance.com/graphql

Step 3: Explore the Schema​

Use GraphQL introspection or browse the API references to discover available operations:

Next Steps​