Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 changes5 2-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

...