Difference between pages "Academic Technology" and "Access Tokens"

From TechHelp@MCLA
(Difference between pages)
Jump to: navigation, search
en>Helpdesk
 
en>StuHelpDesk
(Obtaining an Access Token)
 
Line 1: Line 1:
==Description==
+
Canvas allows for programmatic access to some pieces of information via the [http://instructure.github.com/canvas-lms/doc/api/ Canvas API].  API calls require authorization, and are made on behalf of an authorized user.  The information returned will be different depending on the user you are representing, their roles and permissions.  We are using OAuth2 for remote services to allow access to resources (note: we haven't yet completely the typical Oauth-user delegation flow, but have a pre-generation utility that can be used in the mean time), which means that all API calls will need to be over https, and will require an access token as a means of representing the user.
  
The Academic Technology Center developed as a resource to provide faculty development, consultation, and collaborative partnerships to support the use of technology in teaching and research initiatives at MCLA.
+
You can see the most up-to-date [http://instructure.github.com/canvas-lms/doc/api/API documentation on github]  (note: this link is to the most up-to-date API interface, which may or may not be accurate for locally installed instances of Canvas. If you are not using Canvas Cloud, talk to you site administrator about getting an accurate set of API documentation. Admins, you can generate this documentation by running rake doc:api on the console).
<br><br>
 
In alignment with the College's commitment to prepare students to become active, contributing members of their communities and leaders in their chosen professions, the Academic Technology Center strives to develop an understanding of the individual needs of faculty and their students. The ATC supports faculty as they explore and apply technology as a fundamental set of tools in the academic environment.
 
<br><br>
 
The ATC works to build active partnerships with faculty, staff, students, and others interested in the integration of technology and academic work. Recognizing that academic applications are not separable from the larger technological infrastructure, ATC is an inherent dimension of college-wide technology initiatives - seeking to highlight the beneficial relationships that can exist between technology and education.  
 
  
==Request a Canvas Course==
 
  
Faculty can request access to Canvas by completing the online course request form located at:
+
== Obtaining an Access Token ==
  
[https://nextgensso.com/sp/startSSO.ping?PartnerIdpId=http://sts.mcla.edu/adfs/services/trust&TargetResource=https://dynamicforms.ngwebsolutions.com/Submit/Form/Start/459f88ba-30c3-4c69-829d-2ad70b9f172f Canvas Course Request - Spring 2021]
+
[[Image:approved_integrations.png|300px|thumb|right|Approved Integrations on the user profile page]]
 +
[[Image:generate_an_access_token.png|300px|thumb|right|Generating an access token]]
 +
[[Image:access_token_details.png|300px|thumb|right|Reviewing access token details]]
  
==Contacting Academic Technology==
+
In a user's profile, there is a section titled, "Approved Integrations". This is a way for a user to create an access token that can be shared with a third party, giving the remote service permission to access Canvas resources on behalf of the user.  The user can give a name to the external tool for easier identification, set an expiration, and even revoke access to the API by deleting the token.
  
*Location: Murdock Second Floor
+
Once you have a Canvas login you can create one of these access tokens to use for testing your development projects.  Copy down the token string. This token must be included as a URL query parameter in any API calls made to Canvas.
*Phone: (413)662-5397
+
<div style="clear: right;"></div>
*Phone for Computer Help or Technical Issues: 413-662-5276
+
 
 +
== Making API Calls With an Access Token ==
 +
 
 +
All API calls must also be made over https.  The access token must be included as a URL query parameter in any API calls made to Canvas.  For example, the endpoint to grab the user's list of courses is
 +
 
 +
<pre>GET /api/v1/courses.json</pre>
 +
 
 +
If Bob's access token were "token_of_magical_power" then you would call
 +
 
 +
<pre>GET /api/v1/courses.json?access_token=token_of_magical_powers</pre>
 +
 
 +
to retrieve Bob's list of courses.
 +
 
 +
For a detailed example of using the API, check out the [http://instructure.github.com/canvas-lms/doc/api/basics.html API basics documentation on github].

Revision as of 14:34, 21 July 2011

Canvas allows for programmatic access to some pieces of information via the Canvas API. API calls require authorization, and are made on behalf of an authorized user. The information returned will be different depending on the user you are representing, their roles and permissions. We are using OAuth2 for remote services to allow access to resources (note: we haven't yet completely the typical Oauth-user delegation flow, but have a pre-generation utility that can be used in the mean time), which means that all API calls will need to be over https, and will require an access token as a means of representing the user.

You can see the most up-to-date documentation on github (note: this link is to the most up-to-date API interface, which may or may not be accurate for locally installed instances of Canvas. If you are not using Canvas Cloud, talk to you site administrator about getting an accurate set of API documentation. Admins, you can generate this documentation by running rake doc:api on the console).


Obtaining an Access Token

Approved Integrations on the user profile page
Generating an access token
Reviewing access token details

In a user's profile, there is a section titled, "Approved Integrations". This is a way for a user to create an access token that can be shared with a third party, giving the remote service permission to access Canvas resources on behalf of the user. The user can give a name to the external tool for easier identification, set an expiration, and even revoke access to the API by deleting the token.

Once you have a Canvas login you can create one of these access tokens to use for testing your development projects. Copy down the token string. This token must be included as a URL query parameter in any API calls made to Canvas.

Making API Calls With an Access Token

All API calls must also be made over https. The access token must be included as a URL query parameter in any API calls made to Canvas. For example, the endpoint to grab the user's list of courses is

GET /api/v1/courses.json

If Bob's access token were "token_of_magical_power" then you would call

GET /api/v1/courses.json?access_token=token_of_magical_powers

to retrieve Bob's list of courses.

For a detailed example of using the API, check out the API basics documentation on github.