overview.rst 1.08 KB
Newer Older
Mark Hoeber committed
1
################################################
2
Overview of the edX Platform APIs
Mark Hoeber committed
3 4
################################################

5 6 7
The edX Platform APIs are a rapidly growing and evolving set of capabilities
that enable you to build web, desktop, and mobile applications that work with
your Open edX instance.
Mark Hoeber committed
8

9
The edX Platform APIs use REST design principles and support the JSON data-
10 11
interchange format. The APIs also use edX OAuth 2.0 for :ref:`authentication
<edX API Authentication>`.
Mark Hoeber committed
12

13 14 15
**********************************************
Supported edX Platform API Modules
**********************************************
Mark Hoeber committed
16

17
The following edX Platform APIs are currently supported: 
Mark Hoeber committed
18

19 20
* :ref:`edX Platform Enrollment API Version 1.0`
* :ref:`edX Platform Mobile API Version 0.5`
Mark Hoeber committed
21
* :ref:`Profile Images API Version 1.0`
22
* :ref:`edX Platform User API Version 1.0`
Mark Hoeber committed
23

24 25 26
**********************************************
Experimental edX Platform API Modules
**********************************************
27

28
The following edX Platform APIs are currently experimental: 
Mark Hoeber committed
29

30
* :ref:`EdX Platform Course Structure API Version 0`