Skip to main content

​
SDK setup

Configure credentials on the server. Environment variable names in an application example are inputs you pass to the SDK; your framework must load them. Follow the full server adapter setup, including identity and session callbacks.
.env.local
For SSO, also supply the Cognito credentials required by your identity configuration. Names such as AWS_COGNITO_CLIENT_ID and AWS_COGNITO_CLIENT_SECRET in these guides are application conventions: pass their values into identity.clientId and identity.clientSecret explicitly. Custom identity uses your existing authenticated session instead. Use env: 'staging' or env: 'production' explicitly. The SDK also supports local, which uses staging API configuration and overrides; it is not an offline emulator.

​
Direct TypeScript clients

The composed client can resolve the canonical TIMEBACK_API_CLIENT_ID and TIMEBACK_API_CLIENT_SECRET environment variables, but explicit constructor options make the selected environment and platform clear:
The reviewed clients default to BEYOND_AI; LEARNWITH_AI is a separate endpoint selection. Platform support is service-specific. A constructor accepting a platform does not prove every method matches that platform’s currently deployed routes. See API reference and the Caliper client before changing receivers.

​
Credential and URL fallback names

For individual TypeScript OneRoster, EduBridge, QTI, PowerPath, and Caliper clients, canonical names take precedence over shorthand and service-specific legacy names: Replace ONEROSTER with EDUBRIDGE, QTI, POWERPATH, or CALIPER for that client’s legacy names. The composed client also reads TIMEBACK_ENV. Use each client’s constructor documentation for explicit URL overrides; the different services do not share one universal base URL. The Caliper client uses OAuth client credentials. CALIPER_API_KEY and CALIPER_SENSOR_URL are not credential/config fallbacks in the reviewed package. An event sensor identifies the producer and is not the HTTP ingestion URL.
The reviewed BeyondAI constants use api.staging.alpha-1edtech.ai / api.alpha-1edtech.ai for the main API and separate Caliper hosts. Both staging and production QTI constants point to https://qti.alpha-1edtech.ai/api. Selecting staging therefore does not by itself establish isolation for every service. Confirm the receiver and credentials before creating or changing data.

​
Python

Pass credentials and environment explicitly when creating the Python client or server. Do not assume every TypeScript fallback variable or platform option is identical in Python. See Core client and FastAPI setup.

​
Secret handling

Keep API and SSO client secrets on the server. Exclude local secret files from version control and use your deployment environment’s secret storage. Browser providers communicate with your mounted SDK routes; they do not need these client secrets. The CLI maintains its own credential store. Configuring application environment variables is separate from selecting credentials for timeback resources.