Skip to content

Developers

Welcome! This section is for developers building against the CMDS API — whether you're wiring CMDS into another system, pulling data for reports, automating a workflow, or integrating with a partner platform.

If you're just getting started, read Queries and commands to learn the two basic patterns the API uses, then head to API → Introduction to make your first request.

What you'll find here

Getting started

  • Queries and commands — the core idea behind the API. Queries ask questions (Count, Search, Retrieve); commands change things (Add, Delete, Send).

API

  • Introduction — base URLs, environments, Swagger reference, and a quick-start path to your first successful request.
  • Authentication — Bearer tokens, cookies, and client secrets. Also covers how to generate a long-lifetime token for automated jobs.
  • Request and response formats — conventions for HTTP verbs, pagination, status codes, and headers.
  • Rate limits and throttling — how the API's token-bucket throttling works and how to stay inside your quota.
  • Legacy (API v1) — reference for the older v1 API. Use v2 for new work.

Resources

  • .NET — which .NET versions we target and why.
  • Date and time values — how the API formats timestamps (ISO 8601 with time zone) and why it matters.

Integrations

  • Power BI — step-by-step guide to connecting Power BI to CMDS as a data source.
  • Safe Exam Browser — using SEB to secure online assessments.
  • Single Sign-On — Azure, Google, and LTI-based SSO options.

Need help?

If you're stuck or hit something unexpected, reach out to our support team — we're happy to help you get unblocked.