SDK docs

Python/FastAPI integration

The example SDK keeps Product Plane apps thin. Quibrix owns app-user identity, runtime-profile API keys, entitlement checks, upgrade URLs, and signed webhooks.

Minimal setup

from fastapi import FastAPI
from quibrix_sdk import Quibrix

app = FastAPI()
quibrix = Quibrix.install(app)

Required environment

QUIBRIX_API_KEY=<QUIBRIX_API_KEY>
QUIBRIX_APP_BASE_URL=https://your-nanosaas.example
QUIBRIX_WEBHOOK_SECRET=<QUIBRIX_WEBHOOK_SECRET>
SESSION_SECRET=<SESSION_SECRET>

QUIBRIX_PUBLIC_URL is used for browser redirects to /runtime/auth/** and /runtime/checkout/**. QUIBRIX_API_URL is used for server-to-server calls to /api/runtime/v1/**. Set them only for local development or a custom Quibrix installation.

The SDK installs Starlette session middleware itself when SESSION_SECRET is valid. Do not add a second SessionMiddleware manually.

Useful defaults

• QUIBRIX_PUBLIC_URL defaults to https://quibrix.de.
• QUIBRIX_API_URL defaults to https://quibrix.de.
• QUIBRIX_REDIRECT_URI is optional; the SDK derives QUIBRIX_APP_BASE_URL plus /auth/callback.
• New Runtime Profiles allow /auth/callback by default and resolve it against the profile's Public App Base URL.

Routes added by the SDK

• /login and /register: redirect to Quibrix runtime auth.
• /auth/callback: receives the authorization code from Quibrix.
• /logout: clears the local session and redirects to Quibrix runtime logout.
• /quibrix/webhooks: receives signed Quibrix Product Plane webhooks.