Files
edx-platform/docs/en_us/platform_api/source/overview.rst

31 lines
1.1 KiB
ReStructuredText

################################################
Overview of the edX Platform APIs
################################################
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.
The edX Platform APIs use REST design principles and support the JSON data-
interchange format. The APIs also use edX OAuth 2.0 for :ref:`authentication
<edX API Authentication>`.
**********************************************
Supported edX Platform API Modules
**********************************************
The following edX Platform APIs are currently supported.
* :ref:`edX Platform Enrollment API`
* :ref:`edX Platform Mobile API Version 0.5`
* :ref:`Profile Images API Version 1.0`
* :ref:`edX Platform User API`
**********************************************
Experimental edX Platform API Modules
**********************************************
The following edX Platform APIs are currently experimental.
* :ref:`EdX Platform Course Structure API Version 0`