Scholera Developers

Developer Docs

The technical starting point for evaluating, designing, and operating a Scholera integration.

Integration model

Scholera is designed to complement an institution’s existing learning environment. Integrations connect approved course, identity, roster, and learning-context data to the Scholera services an institution enables.

Environments

Use a dedicated test environment with synthetic or approved test data before connecting production systems. Scholera coordinates environment access, credentials, and permitted scopes during onboarding.

Authentication

Credentials are scoped to the approved integration and environment. Store secrets only in a managed secret store, rotate them when team access changes, and never expose them in client-side code or logs.

API conventions

  • Send and receive JSON over HTTPS.
  • Use stable institutional identifiers instead of display names.
  • Treat non-success responses as actionable and retry only transient failures.
  • Use idempotency controls for operations that may be retried.

Getting access

API references and environment-specific endpoints are shared after an integration request is reviewed. This keeps credentials, capabilities, and documentation aligned with the institution’s approved use case.