New API docs

The API has its own docs site.

Partners and publishers learn the API from one public site.

Built

  • Six guidesIntroduction, quickstart, authentication, error codes, versioning and a changelog.
  • An API referenceBuilt from the committed OpenAPI document, so it matches the API.
  • The safety rule, shown in codeThe quickstart makes a marking, then shows that an API key cannot approve a mark.
  • Published by a workflowA workflow publishes the site when the API's contract or the guides change.

The docs describe the API only and hold no student data. The API behind them runs on staging, not in production.