Migrating LMS APIs to DRF

[awais786]

This document Big changes to edx-platform contains a segment to convert

Improve HTTP APIs.

1. Switch all APIs to be using DRF with standard Auth classes.
2. Document APIs to clearly separate Operator, Instructor, and Learner APIs.
3. Map existing APIs to product features and build out missing APIs.
4. Define best practices for how to build APIs?

How to test Instructor APIS

Tasks releated with 1st point Switch all APIs to be using DRF with standard Auth classes.

Beta Give feedback

1. Update lms api get_student_progress_url to DRF #35058
   +0
   
2. update lms api list_course_role_members to DRF #35059
   +0
   
3. update get_problem_responses to DRF #35060
   +0
   
4. upgrade get_grading_config api with DRF #35061
   +0
   
5. update get_issued_certificates to DRF #35062
   +0
   
6. update get_students_features to DRF #35064
   +0
   
7. update get_students_who_may_enroll to DRF #35065
   +0
   
8. update add_users_to_cohorts to DRF #35066
   +0
   
9. update get_course_survey_results to DRF #35067
   +0
   
10. update get_proctored_exam_results to DRF #35068
    +0
    
11. update get_anon_ids api to DRF #35069
    +0
    
12. upgrade get_student_enrollment_status api with DRF #35070
    +0
    
13. update get_student_progress_url to DRF #35071
    +0
    
14. update reset_student_attempts to DRF #35072
    +0
    
15. upgrade rescore_problem to DRF #35073
    +0
    
16. update override_problem_score to DRF #35074
    +0
    
17. update rescore_entrance_exam to DRF #35075
    +0
    
18. update list_background_email_tasks to DRF #35283
    +0
    
19. update list_email_content to DRF #35112
    +0
    
20. Upgrade list_instructor_tasks to DRF #35114
    +0
    
21. update list_entrance_exam_instructor_tasks to DRF #35232
    +0
    
22. update list_report_downloads api upgrade to DRF #35347
    +0
    
23. update list_report_downloads to DRF #35351
    +0
    
24. update export_ora2_data to DRF #35352
    +0
    
25. update export_ora2_summary to DRF #35353
    +0
    
26. update export_ora2_submission_files to DRF #35355
    +0
    
27. update calculate_grades_csv to DRF #35356
    +0
    
28. update problem_grade_report to DRF #35357
    +0
    
29. upgrade list_forum_members api to DRF #35344
    +0
    
30. update send_email api to DRF #35346
    +0
    
31. update_forum_role_membership api to DRF #35339
    +0
    
32. update change_due_date to DRF #35354
    +0
    
33. update reset_due_date to DRF #35358
    +0
    
34. update show_unit_extensions api to DRF #35359
    +0
    
35. update mark_student_can_skip_entrance_exam api to DRF #35284
    +0
    
36. update start_certificate_generation to DRF #35360
    +0
    
37. update start_certificate_regeneration to DRF #35361
    +0
    
38. update certificate_exception_view to DRF #35362
    +0
    
39. update generate_certificate_exceptions to DRF #35363
    +0
    
40. update generate_bulk_certificate_exceptions to DRF #35364
    +0
    
41. update api certificate_invalidation_view to DRF #35365
    +0
    
42. update register_and_enroll_students api to DRF #35085
    +0
    
43. update modify_access api to DRF #35262
    +0
    
44. update bulk_beta_modify_access api to DRF #35285
    +0
    
45. update show_student_extensions api to DRF #35330
    +0
    

Tasks

Beta Give feedback

No tasks being tracked yet.

[awais786]

PRS List

1. feat: converting existing api to drf base api ( 1st api ). get_student_progress_url #35039
2. feat: Upgrading api list_course_role_members ( 2nd api ) #35105
3. feat: upgrading simple api to drf compatible ( 3rd api ) list_email_content #35111
4. feat: upgrading simple api to drf compatible (4th api ), list_entrance_exam_instructor_tasks #35135
5. feat: Upgrading api to use drf 5th api. register_and_enroll_students api #35084
6. feat: upgrading simple api to drf compatible (6th) . modify_access #35260
7. upgrade get_students_features api with DRF( 7th api ) #35323
8. feat: get_students_who_may_enroll update api to DRF ( 8th ) #35174
9. feat: show_student_extensions upgrading api to drf compatible ( 9th )  #35148
10. feat: upgrading list_instructor_tasks to DRF ( 10th ) #35332
11. feat: Update forum role membership api to DRF ( 11th ) #35343
12. feat: upgrading get_anon_ids api to drf compatible (12) #35345
13. feat: upgrade list_report_downloads api to DRF ( 13th ) #35350
14. feat: list_forum_members-to-drf api to drf ( 14th ) #35366
15. feat: upgrade send_email api to drf ( 15th ) #35387
16. feat: upgrade change_due date to drf ( 16th ) #35392
17. feat: upgrading simple api to drf compatible ( 17th ) #35394
18. feat: upgrading show_unit_extensions api to drf compatible ( 18th ) #35395
19. feat: upgrade reset_student_attempts api to drf ( 19th ) #35404
20. feat!: upgrading get_grading_config api with DRF ( 20th ) #35463
21. feat!: upgrading mark_student_can_skip_entrance_exam api with DRF ( 21 ) #35460
22. feat: upgrade get_student_enrollment_status api with drf (22nd) #35464
23. feat!: upgrade certificate_invalidation_view to drf ( 23 ) #35521
24. feat!: upgrade get_issued_certificates to DRF ( 24 ) #35534
25. feat!: upgrading start_certificate_generation-to-drf api to DRF ( 25 ) #35536
26. feat!: upgrade generate_bulk_certificate_exceptions to drf ( 26 ) #35577
27. feat!: upgrading api generate_certificate_exceptions to drf ( 27 ) #35584
28. feat!: upgrade certificate_exception_view to DRF ( 28 ) #35594
29. feat!: upgrade start_certificate_regeneration to drf ( 29 ) #35599
30. feat!: upgrade bulk_beta_modify_access to drf ( 30 ) #35604

[awais786]

Testing guide lines via postman

How to generate csrf
http://local.edly.io:8000/csrf/api/v1/token
It will return the csrf token which is required for some apis.

For login authentication
http://local.edly.io:8000/api/user/v2/account/login_session/
body-form-data
email_or_username = admin
password = edx

headers information
x-csrftoken: csrf fresh token

Generate access token via postman
http://local.edly.io:8000/oauth2/access_token

You can curl command as well as follows. Just pass your token.

curl --location ‘http://local.edly.io:8000/courses/course-v1:edx+cs222+2311/instructor/api/get_student_progress_url’
–header ‘Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJvcGVuZWR4IiwiZXhwIjoxNzI0MjMzNDc2LCJncmFudF90eXBlIjoiY2xpZW50LWNyZWRlbnRpYWxzIiwiaWF0IjoxNzI0MjI5ODc2LCJpc3MiOiJodHRwOi8vbG9jYWwuZWRseS5pby9vYXV0aDIiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiNlX3VzZXIiLCJzY29wZXMiOlsicmVhZCIsIndyaXRlIiwiZW1haWwiLCJwcm9maWxlIl0sInZlcnNpb24iOiIxLjIuMCIsInN1YiI6IjI2MjYyNDAxYzUyOGQ3YzRhNmJiZWFiZTA0NTVlYzQ2IiwiZmlsdGVycyI6W10sImlzX3Jlc3RyaWN0ZWQiOmZhbHNlLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiZW1haWwiOiJsb2dpbl9zZXJ2aWNlX3VzZXJAZmFrZS5lbWFpbCIsIm5hbWUiOm51bGwsImZhbWlseV9uYW1lIjoiIiwiZ2l2ZW5fbmFtZSI6IiIsImFkbWluaXN0cmF0b3IiOmZhbHNlLCJzdXBlcnVzZXIiOmZhbHNlfQ.t1GjtoPntvTgY153qlkoUHZ2N43U-Ac5uJY5EUTEo0g’ 
-X POST --form ‘unique_student_identifier=“audot”’

[AmauryVanEspen]

Amazing list and job @awais786 ! thank you very much for this very relevant list !
Where can we find the postman workspace & collections ?
Thanks.
Amaury

[awais786]

@AmauryVanEspen you can find some help material from here

Please let me know if you have some questions.

[awais786]

@AmauryVanEspen You can use these open tickets.

[AmauryVanEspen]

Hi @awais786
trying to set up the Postman Collection, with the CSRF tricks, i still have an issue
https://openedx.atlassian.net/wiki/spaces/AC/pages/3516268561/How+to+authenticate+and+query+edX+APIs+with+Postman
returning : 405 Method Not Allowed

not sure about how to add the script : var xsrfCookie = postman.getResponseCookie("csrftoken"); postman.setEnvironmentVariable('csrftoken', xsrfCookie.value);

collection folder ? the post-request script of the POST ?
Thanks.
Amaury

[awais786]

Hi @awais786 trying to set up the Postman Collection, with the CSRF tricks, i still have an issue https://openedx.atlassian.net/wiki/spaces/AC/pages/3516268561/How+to+authenticate+and+query+edX+APIs+with+Postman returning : 405 Method Not Allowed

not sure about how to add the script : var xsrfCookie = postman.getResponseCookie("csrftoken"); postman.setEnvironmentVariable('csrftoken', xsrfCookie.value);

collection folder ? the post-request script of the POST ? Thanks. Amaury

Please try this.
https://discuss.openedx.org/t/authenticate-with-oauth-token-to-access-api-endpoints-instructor-apis-d/13658

[awais786]

@AmauryVanEspen Please check the last post with postman collection

[AmauryVanEspen]

@AmauryVanEspen Please check the last post with postman collection

hi @awais786
thanks,
which instance should i use ?
prod ? or a simple EduNExt Trial ? or is there an instance available for migration LMS API to DRF available ?
Thanks
Regards
Amaury

[awais786]

@AmauryVanEspen I am using local tutor instance for testing purpose.