Developer docs

Build with Vigilimate

Three ways to integrate, from the lowest-effort to the most flexible:

1 · Embed

Drop in a single iframe

Best for partner apps that already have logged-in users and want learners to complete training without a second login.

<script src="https://app.vigilimate.com/embed/embed-loader.js"></script>
<mtga-embed
  src="https://app.vigilimate.com/embed/program/your-program?token=<JIT>"
  autoresize>
</mtga-embed>

The token is a short-lived JWT your backend mints — see step 3.

2 · SDK

Use the TypeScript SDK

Typed REST client + React component + token minting. Same iframe under the hood.

import { MTGAClient } from "@mtga/sdk";
import { MTGAEmbed } from "@mtga/sdk/react";

const mtga = new MTGAClient(
  { apiKey: process.env.MTGA_API_KEY! },
  { keyId: ..., secret: ..., partnerIssuer: "your-app" },
);

const url = await mtga.buildEmbedUrl(
  { kind: "program", slug: "compliance-2026" },
  { partnerUserId: "user-42", email, name },
);

// then in your component:
<MTGAEmbed src={url} onProgramComplete={(e) => track(e)} autoresize />

3 · REST API

Drive everything from your backend

Versioned at /api/v1. Authenticate with a server API key (Bearer).

curl https://app.vigilimate.com/api/v1/programs \
  -H "Authorization: Bearer mtga_sk_..."

curl -X POST https://app.vigilimate.com/api/v1/assignments \
  -H "Authorization: Bearer mtga_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"user_id":"...", "program_slug":"compliance-2026"}'

Reference

OpenAPI 3.1 spec — full machine-readable surface (paste into Swagger UI / Scalar / Postman).
Embed protocol — postMessage events + commands between iframe and parent.
Webhooks — outbound event subscriptions, signature verification.

Quickstart

In Vigilimate, open Admin → Settings → Developer API and create an API key. Tick “Also mint a JIT signing secret”. Copy both values — they’re shown once.
Add the parent origin (e.g. https://partner.example.com) to the Embed origins allowlist.
On your backend, mint a JIT token for the user (see SDK above, or sign HS256 by hand: kid = api_key id, iss = your app id, sub = your user id, aud = “mtga”, exp <= 1h).
Render <mtga-embed src="https://app.vigilimate.com/embed/program/<slug>?token=<jwt>"> on the page.
Listen for the program.completed event to update your own state.