Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 2.45 KB

0002-api-connection.rst

File metadata and controls

57 lines (39 loc) · 2.45 KB
Raw

2. API connection

Status

Accepted

Context

We must connect this plugin with the available APIs in the Open edX platform to perform commerce actions raised in Purpose of this repo.

Decisions

  • This plugin uses the OAuth2 and JWT authentication following the standards in Open edX from the OEP-42 Authentication.
  • To generate the JWT token, we use information such as client_id and client_secret as specified in the doc of How to Use the REST API.
  • The JWT must be created with a Staff user to use all the endpoints this plugin needs.
  • We use the LMS APIs to do the basic functionalities.
    • To obtain info about enrollments, we use GET /enrollment/v1/enrollments/
    • To create enrollments, POST /enrollment/v1/enrollment
    • To perform an unenroll, we use the same endpoint to create enrollment, but we set the attribute is_active in False.
    • We can pass the flag force in the request to allow you to enroll; disregard the course's enrollment end dates.
    • To know if a user exists in the platform, GET /user/v1/accounts
    • If the user does not exist yet, we can get, create, or delete an enrollment allowed with: GET, POST, DELETE /api/enrollment/v1/enrollment_allowed/

Consequences

  • You need to create an OAuth Application in your platform with a Staff user to use this plugin.
  • The backward compatibility depends on the JWT support in previous Open edx versions.
  • We can use the course enrollment allowed API since Quince.
  • The actions of this plugin are restricted by the endpoints mentioned above. For example, we cannot enroll someone in a course that is in invite-only mode.

Rejected Alternatives

  • Create another plugin to add the needed endpoints: we could use the existing LMS APIs, and we added the course enrollment-allowed API to the edx-platform and brought email support in some of the endpoints.

References