Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Here is a proposal for supporting a trichotomy of REST APIs in the edX platform.

API TypeFeature-driven APIs
(API for development)		Service APIs
(API for extensions and add-ons)		Business-driven APIs
(API as a product)
Use Casefeature developmentfeature enhancementsintegration with partner environments
Usersopen edX developerscourse teams, open edX vendor communityadministrators, researchers
Clientsfrontend and backend servicesexternal servicesexternal systems operated by partners
Support Lifecycle1 open edX named release2 years with a migration plan, if API changes2-3 years with a migration plan, if API changes
Governance
  • less governance
  • follows edX API conventions
  • follows OEP process for major APIs
  • high governance on additions/edits
  • business case made for support and development effort
  • follows edX API conventions
  • follows DDD practices on naming
API Examples
  • student dashboard
  • password reset
  • Real-time Events: xAPI and Caliper
  • Proctoring plugin interface
  • Account retirement hooks
  • Grades
  • Course provision
  • User provision
  • Catalog
Client Examples
  • mobile apps
  • studio frontend
  • enterprise admin portal
  • adaptive engine
  • email provider
  • on-campus SIS
  • corporate reports


  • No labels