ede8bff78a
Previously, if there were any errors in the API docs (such as a missing nickname) then the whole 'live' API docs page would fail to load. This corrects the problem by making the errors into console warnings. Test Plan: - load /doc/api/live - there should be no message "SwaggerOperations must have a nickname" at top center - API calls should work (with an API key set) Fixes SIS-557 Change-Id: Iecd545564a5f7e1277b56e0a261a718c23856174 Reviewed-on: https://gerrit.instructure.com/41749 Tested-by: Jenkins <jenkins@instructure.com> QA-Review: Jeremy Putnam <jeremyp@instructure.com> Reviewed-by: Ken Romney <kromney@instructure.com> Product-Review: Duane Johnson <duane@instructure.com> |
||
|---|---|---|
| .. | ||
| appendix/html | ||
| docstring/html | ||
| fulldoc/html | ||
| layout/html | ||
| method_details/html | ||
| tags | ||
| topic/html | ||
| README.md | ||
| assignment_tools.md | ||
| compound_documents.md | ||
| editor_button_tools.md | ||
| endpoint_attributes.md | ||
| file_uploads.md | ||
| homework_submission_tools.md | ||
| link_selection_tools.md | ||
| masquerading.md | ||
| navigation_tools.md | ||
| oauth.md | ||
| object_ids.md | ||
| pagination.md | ||
| sis_csv.md | ||
| tools_intro.md | ||
| tools_xml.md | ||
README.md
Welcome to the Canvas LMS API Documentation
Canvas LMS includes a REST API for accessing and modifying data externally from the main application, in your own programs and scripts. This documentation describes the resources that make up the API.
To get started, you'll want to review the general basics, including the information below and the page on Authentication using OAuth2.
Schema
All API access is over HTTPS, against your normal Canvas domain.
All API responses are in JSON format.
All integer ids in Canvas are 64 bit integers.
For POST and PUT requests, parameters are sent using standard HTML form encoding (the application/x-www-form-urlencoded content type).
POST and PUT requests may also optionally be sent in JSON format format. The content-type of the request must be set to application/json in this case. There is currently no way to upload a file as part of a JSON POST, the multipart form type must be used.
As an example, this HTML form request:
name=test+name&file_ids[]=1&file_ids[]=2&sub[name]=foo&sub[message]=bar
would translate into this JSON request:
{ "name": "test name", "file_ids": [1,2], "sub": { "name": "foo", "message": "bar" } }
With either encoding, all timestamps are sent and returned in ISO 8601 format (UTC time zone):
YYYY-MM-DDTHH:MM:SSZ
Authentication
API authentication is done with OAuth2. If possible, using the HTTP Authorization header is recommended. Sending the access token in the query string or POST parameters is also supported.
OAuth2 Token sent in header:
curl -H "Authorization: Bearer <ACCESS-TOKEN>" https://canvas.instructure.com/api/v1/courses
OAuth2 Token sent in query string:
curl https://canvas.instructure.com/api/v1/courses?access_token=<ACCESS-TOKEN>
Read more about OAuth2 and how to get access tokens.
API Terms of Service
Please carefully review The Canvas Cloud API Terms of Service before using the API.
SSL
Note that if you make an API call using HTTP instead of HTTPS, you will be redirected to HTTPS. However, at that point, the credentials have already been sent in clear over the internet. Please make sure that you are using HTTPS.
About this Documentation
This documentation is generated directly from the Canvas LMS code itself. You can generate this documentation yourself if you've set up a local Canvas environment following the instructions on Github, run the following command from your Canvas directory:
bundle exec rake doc:api