Skip to main content
Version: 2026-08-19 (archived)

Registering your app

Register your app to tell Voshi it exists and to get your API key.

Register in the dashboard​

Open the dashboard

Go to zen.voshi.com/app/ltiaas/s/ and sign in. If you don't have builder access yet, contact the MyEducator team.

Apps → Register App

Fill in the form:

  • App Name — shown to instructors when they add your app to a course.
  • Callback URL — your launch receiver endpoint. See the rules below.
  • Description / Logo URL — optional.
Save your API key

The response shows your API key exactly once — copy it now and store it securely, like you would a password. It authenticates the grades API and the management API.

Add locations

In Apps → your app → Settings → Locations, define the destinations instructors can place in their courses. Every app starts with one default "Home" location. See Locations.

You can edit the name, callback URL, description, and logo later in Apps → your app → Settings, or via the management API. Configuration changes apply immediately — including to placements instructors have already made.

Callback URL rules​

The callback URL is validated when you set it and re-checked at every launch:

  • Must be an absolute https:// URL (no http://, no relative paths).
  • Must point at a publicly-routable host — URLs that resolve to private, loopback, or link-local addresses are rejected. Your local machine can't receive launches; use a tunnel with a public HTTPS hostname or a deployed environment during development.

App status​

StatusMeaning
draftThe initial status. The app cannot be placed in courses or launched — it's invisible to instructors.
activeLive: instructors can place it, launches are forwarded to your callback URL.
suspendedDisabled by the platform team. Launches and API calls are rejected.

Only the Voshi platform team can change your app's status. There is currently no sandbox or simulated-launch tool, so the path to testing end-to-end is:

  1. Build your receiver and grade flow against these docs.
  2. Contact the MyEducator team to activate your app.
  3. Test from a real LMS course — place your locations, launch as an instructor and as a student, and verify grades land in the gradebook.

Your API key​

The key has the form:

ltiaas_<app-id>_<secret>
  • It's shown once at registration. Voshi stores it encrypted and cannot show it again — the dashboard displays only a hint (ltiaas_…last4).
  • Keep it server-side only. It authorizes grade submission and app configuration changes for your app.
  • It is not involved in launch verification — launches are verified against Voshi's public keys.

If you lose your API key​

Contact the MyEducator team — they can issue you a new key.

Team members​

Apps are managed by their members. In Apps → your app → Members you can invite teammates by email; every member has full management rights over the app, and an app always retains at least one member.