Frequently Asked Questions
      Back to home
      1. Cidi Labs Help Center
      2. ReadyGO
      3. Frequently Asked Questions

      ReadyGO Scoped Developer Keys

      ReadyGO has recently added support for scoped developer keys. This is an important security feature for limiting the use of the Canvas API to its intended purposes. Developer keys are used to create tokens which grant access to the Canvas API. By scoping the developer key we are telling Canvas which API calls users have access to.


      Setting up the scoped developer key requires the following steps:

      • Enabling scopes on the Cidi Labs developer key
      • Selecting the API calls needed for ReadyGO to function
      • Deleting existing user tokens in the ReadyGO database which are not scoped


      This last step is not something an institution can do on its own, which is why this installation is best done on a call with Cidi Labs. Please submit a support ticket if you are interested in setting up scoped developer keys at your institution.


      ReadyGO API Endpoints:

      • url:GET|/api/v1/accounts
      • url:GET|/api/v1/accounts/:account_id/sub_accounts
      • url:GET|/api/v1/accounts/:account_id/courses
      • url:GET|/api/v1/courses/:course_id/assignments
      • url:GET|/api/v1/courses/:course_id/assignments/:id
      • url:GET|/api/v1/courses
      • url:GET|/api/v1/courses/:id
      • url:GET|/api/v1/courses/:course_id/users
      • url:PUT|/api/v1/courses/:id
      • url:GET|/api/v1/courses/:course_id/enrollments
      • url:GET|/api/v1/accounts/:account_id/terms
      • url:GET|/api/v1/courses/:course_id/external_tools
      • url:POST|/api/v1/courses/:course_id/external_tools
      • url:DELETE|/api/v1/courses/:course_id/external_tools/:external_tool_id
      • url:GET|/api/v1/courses/:course_id/modules
      • url:GET|/api/v1/courses/:course_id/pages
      • url:GET|/api/v1/courses/:course_id/front_page
      • url:GET|/api/v1/courses/:course_id/pages/:url_or_id
      • url:GET|/api/v1/courses/:course_id/quizzes
      • url:GET|/api/v1/users/:user_id/profile