Community

sam_ofloinn · ‎01-20-2020

For my project I need to get all the pages of data for a project. I can make cURL requests on data endpoints and get all the pages I want. For example, see this DD of some page data that includes all four links: "Current", "Next", "Last" and "First": array:4 [ ▼ 0 => " Link: <https://ucc.test.instructure.com/api/v1/accounts/1/courses?page=1&per_page=100>; rel="current" " 1 => " <https://ucc.test.instructure.com/api/v1/accounts/1/courses?page=2&per_page=100>; rel="next" " 2 => " <https://ucc.test.instructure.com/api/v1/accounts/1/courses?page=1&per_page=100>; rel="first" " 3 => " <https://ucc.test.instructure.com/api/v1/accounts/1/courses?page=218&per_page=100>; rel="last" \r " ] However, sometimes when I get page link data, they will not include the "last" field, I'll only have the first three to work with: "Current", "Next" and "First": array:3 [ ▼ 0 => " Link: <https://my.instructure.com/api/v1/accounts/1/courses?search_by=course&search_term=2019&page=1&per_page=100>; rel="current" " 1 => " <https://my.instructure.com/api/v1/accounts/1/courses?search_by=course&search_term=2019&page=2&per_page=100>; rel="next" " 2 => " <https://my.instructure.com/api/v1/accounts/1/courses?search_by=course&search_term=2019&page=1&per_page=100>; rel="first" \r " ] To clarify, in that above example, I can confirm there are far more pages than just two, there are at least seven. So I know there are many more pages to fetch, but for some reason I don't understand, there isn't a "last" link available. For my project, I want to be able to always link to the last page, so having that "Last" link would be very valuable. I have read the Canvas API documentation on Pages, on Endpoints, and on Courses and Users among other pages, but nothing there seems to have the solution. Here are two URLs that make sure to include the "last" page: "https://ucc.test.instructure.com/api/v1/accounts/1/courses?per_page=100"; "https://ucc.test.instructure.com/api/v1/accounts/1/users?per_page=50"; Here are some which don't. "https://ucc.test.instructure.com/api/v1/courses/$id/enrollments?page=$pageNumber&per_page=50&sort=name;" "https://ucc.test.instructure.com/api/v1/accounts/1/courses?search_by=course&search_term=$sis_course_id&per_page=100" Does anyone know how I might be able to get it? Or have any ideas that might point me in the right direction? Any help at all would be greatly appreciated

sam_ofloinn · ‎01-09-2020

Forgive the delay in my response. I don't know about making requests from Canvas to an application, only about applications requesting data from Canvas endpoints. If you want control over Canvas' own actions, contact your department's admin and see what he can do, but otherwise I understand it's not that kind of application which lets people command it liberally: only to request resources from it.

sam_ofloinn · ‎12-10-2019

Mahmoud, At a guess, perhaps Postman might be what you need.. I don't use it myself, but I hear it recommended for reading the values of URLs, tokens, and testing them quickly. It is universal with other languages, so those techs shouldn't be a burden on it. That said, I don't have enough details about your problem to give any further help

sam_ofloinn · ‎12-04-2019

That does seem very helpful, Peter, thank you. I tested it out now and it seems to work superb. I have just one concern, though, and that is the possibility of courses stuck in other subdirectories of accounts. e.g "api/v1/accounts/2/courses?..." . Do you think that might be something to watch out for? If so, what might I be able to do about it? EDIT: We were able to find values from such subdirectories even with this one query. Thank you very much!

sam_ofloinn · ‎12-03-2019

Thank you, I'll see what I can manage!

sam_ofloinn · ‎12-03-2019

Indeed, Brian, indeed! I'm willing to do it if necessary (and permitted), I just wish to first fully understand what it is I'm doing! Speaking of permissions, about the database. I understand you're recommending these be stored in a MySQL table, but would a SQLite table be just as plausible? This project aims to be as low-maintenance as possible, and so I have a small SQLite one set up already for this project, so it'd be easier for me if I could use this instead of replacing it for a MySQL one. I actually have Postman, but I've never used it to generate code snippets before. Are there any tutorials you'd recommend for precisely that?

sam_ofloinn · ‎12-03-2019

Very interesting, thank you Brian. I've ran this report now, will look forward to the results. But for clarity's sake, since I'm making a call from the instructure website directly here - instead of getting data from Canvas endpoints using my project - what would happen if the course details were to change? For instance, if a course SIS ID were to be altered, or a course were to be added/removed? I'd have to call this project again in that case, I imagine. Which would mean setting up a script that runs this report at some interval, gets the results from some email, and replaces the existing database values with the results from these. Which I admit sounds like a lot! Do I have that right? And if so, am I missing anything there?

sam_ofloinn · ‎12-03-2019

Brian, thank you very much. I will look into checking if we have the option to use an SQL table for this. While I wait to hear back, can I ask you to go into a bit more detail please on how I could use admin reports/the provisioning report? I admit this is a new Canvas concept to me. EDIT: Would a SQLite table be able to do the job just as well?

sam_ofloinn · ‎12-03-2019

In my custom application, I have a program that successfully searches for and finds a course when given its SIS Course ID. Using this code written in PHP Laravel: $sis_course_id = $request->sis_course_id; //gets the SIS Course ID $courseURL = "https://my.instructure.com/api/v1/courses/sis_course_id:$sis_course_id"; //parsed into a cURL request, gets the data from this endpoint with the matching SIS Course ID. This code works perfectly if I have the precise SIS Course ID as saved in the Canvas endpoint. But it fails if I type in only part of that SIS Course ID, which is what I've been asked to do. Instead of the full course name (e.g "xxx-somePhraseWithNumbers11Here"), they want it possible to search with just a fraction of that (i.e the "somePhraseWithNumbers11Here" part, without the "xxx-" portion. I've been reviewing the Canvas documentation on the courses endpoint once again, but if what I am looking to do is listed in there as a function, I seem to have overlooked it. Is it possible to find a course given only part of its SIS ID? Any thoughts would be very useful

sam_ofloinn · ‎11-27-2019

My current project asks me to develop a webpage that allows someone to find a single course, if given its name or ID. Let's say name, for now. To that end, I'm following the official documentation here. The two sections that seem most useful are "List Your Courses" and "Get Single Course". The latter being more precise to what I want. However, I'm conscious that the users I'm developing this for may not always have the course IDs on hand. Therefore, I'd like them to be able to find the course details on Canvas with just the course's name. I've reviewed the request parameters for both, but I don't see an option to search by name. I see things like "enrollment_type", "enrollment_role_id", "teacher_limit". etc. Even in "include[]", the optional parameters there cover things like scores, accounts and terms, but not the course name. I do not know yet if my department will be able to use just the course IDs to searhc. So just in case, it'd be very handy to be able to search by the name as a backup. Is it possible to make an endpoint request from Canvas like I'm looking for?

sam_ofloinn · ‎11-26-2019

Brian, I had misunderstood that aspect while reading, it seems. That helps me noticeably, thank you. I'm able to simply call "https://my.test.instructure.com/api/v1/accounts/self/users?search_term=FirstName+Surname" and find a specific user that way.

sam_ofloinn · ‎11-25-2019

I'm creating a custom web application for my university that allows users to search for a single user in Canvas. I've studied the documentation here: https://canvas.instructure.com/doc/api/users.html#method.users.api_index From what I understand, I can get a single user if I have their ID. "GET /api/v1/users/:id" However, in building my page, I am thinking of users who may not have the ID of the person they are thinking of: who may only have their name. I am aware that the base Canvas site has this functionality. How do I use the People page in an account? However, I am creating a custom page, that is its own application yet uses Canvas endpoints to use its data. Hence I need this new app to have this functionality. I imagine I can search my entire directory of users until I find one with a matching name, but I also fear that'd have an incredibly heavy load. Is there any other method I can use to find just one user?

sam_ofloinn · ‎11-15-2019

I'm developing a new application for Canvas, and I just want to verify one thing. Is it possible to program a new webpage on my server, https://my.instructure.com, using a text editor or other material? Or would anything I make have to be its own page that works with Canvas endpoints and such? EDIT: To expand on this some more, it's my understanding that while Canvas gives great assistance to any new software that wishes to use its resources, via endpoints, it does not permit aspects such as https://my.instructure.com/newWebpage or https://my.instructure.com/existingEndpoint/newEndpoint. Is that accurate?

sam_ofloinn · ‎11-15-2019

I have put it there, as well as in the Redirect URI (legacy) box. Here is a screencap: This also matches the redirect URI in the code that points to Canvas' OAuth2 authentication. I will note that these redirects work for other elements. Namely, if I change my redirect route to any other page, it works. If I point to any other redirect route that I've coded, it also works. This block of code - which I'm initially asking Canvas to redirect to after authorisation - is the problem. I was advised on this block of code by numerous laravel passport tutorials and official documentation. I'm aware laravel is not the specialty of many people here, but in case it is of use: Route::get('/callback', function (Request $request) { Log::info("Entered callback"); $state = $request->session()->pull('state'); //is returning null throw_unless( strlen($state) > 0 && $state === $request->state, InvalidArgumentException::class ); $http = new GuzzleHttp\Client; $response = $http->post('http://my.test.instrucutre.com/login/oauth2/auth?', [ 'headers' => [ 'Accept' => 'application/json', ], 'form_params' => [ 'grant_type' => 'authorization_code', 'client_id' => '10', //only a client ID in my laravel homestead database 'client_secret' => 'DKwYRnNg30GVcIYKiRRwtPpCIiVb8FBYZft5iBYqx', //corresponding client secret for laravel database 'redirect_uri' => '192.168.10.10/callback', 'code' => $request->code, ], ]); return json_decode((string) $response->getBody(), true)['access_token']; //returns null }); I was recommended to use Passport in order to be able to use OAuth2 on Canvas, but now I'm wondering if there was some confusion, if that recommendation was accurate to my problem. If my project is already using Canvas, and I can make clients on it, and I can authorise those clients, is Passport essentially doing the same thing? Is this essentially a redundancy? EDIT: It might also be worth noting that, even in the cases of successful redirects by the OAuth2 server, I'm not sure where to see the access token that I hear is generated.

sam_ofloinn · ‎11-14-2019

Peter, thank you very much for the reply. For the client ID, I have tried two different things so far: 1) the ID of a client when I make a client using Laravel Passport and my homestead database 2) and the actual Developer Key I have generated. Neither have worked. I actually didn't realise developer keys have IDs of their own. Where can I see these? The only traits I see on my Canvas page's Developer Key section for my developer keys are a key's name, its key value, and its owner email. Image here: https://i.imgur.com/7kufSre.png Thank you very much for the test site link. EDIT: I feel embarrassed now, but it just dawned on me. The value in the Details section. The one before you hit "Show Key." That's not the key in a condensed form. That's the actual ID for the developer key. I put this in now, where it asked for my client ID, and it seems to have gotten past that issue. I've gotten a new error now: "while(1);{"error":"invalid_request","error_description":"redirect_uri does not match client settings"}" Since that isn't tied to this thread's original question, I'll consider this answered. But if you've any advice on that error, I'd appreciate that.

sam_ofloinn · ‎11-13-2019

So I'm the admin of a Canvas test server, and want to set up OAuth2 authentication for my webpage. I've generated a developer key after logging into "https://my.test.instructure.com" and setting up a developer key from there. Let's call the developer key "myTestKey". And in my code, I made a redirect to the website like this: https://my.test.instructure.com/login/oauth2/auth?client_id=myTestKey&redirect_uri=192.168.10.10%2Fcallback&response_type=code&scope=conference However, the result I get is this: while(1);{"error":"invalid_client","error_description":"unknown client"} Is this not the correct use of a developer key? How should I be using it instead to get authentication?

sam_ofloinn · ‎11-12-2019

I'm developing an OAuth2 Authentication client-server program using Laravel. My code looks like this: Route::get('/hi', function() { // Build the query parameter string to pass auth information to our request $query = http_build_query([ 'client_id' => 10, 'redirect_uri' => '192.168.10.10/callback', 'response_type' => 'code', 'scope' => 'conference' ]); // Redirect the user to the OAuth authorization page return redirect('https://my.test.instructure.com/login/oauth2/auth?' . $query); }); It redirects me to https://my.test.instructure.com/login/oauth2/auth?client_id=10&redirect_uri=192.168.10.10%2Fcallback&response_type=code… as needed, but the result I get from that page confuses me: while(1);{"error":"invalid_client","error_description":"unknown client"} It seems Canvas doesn't recognise the client. Even though, on my machine at least, I've created a good many. Why exactly is this happening? I'm unfamiliar with what's going on here. Looking up similar instances says I need a developer key, and while I've created one now, I don't know what to do with it. Any replies would be greatly appreciated.

sam_ofloinn · ‎11-12-2019

Hello Stephen, Thanks for your research on this, it's helped me out. I've gotten myself a developer key now, but I'm wondering how I might apply that to my routes? Where exactly should my clients put this developer key? In the route::get that redirects to the authentication page, perhaps?

sam_ofloinn · ‎11-12-2019

I've been reviewing the Canvas documentation of OAuth2 endpoints, as in this link. From here, it shows this example of what a redirect example looks like: GET https://<canvas-install-url>/login/oauth2/auth?client_id=XXX&response_type=code&state=YYY&redirect_uri=https://example.com/oauth_complete I'm having trouble developing my own OAuth2 redirect right now: to help pinpoint the problem, I want to confirm if I understand this part correctly. In my example, could it look like this? https://my.test.instructure.com/login/oauth2/auth?client_id=1&response_type=code&state=*&redirect_uri=https://www.google.com/oauth_complete Or even like this? https://my.test.instructure.com/login/oauth2/auth?client_id=7&response_type=code&state=&redirect_uri=my_route/oauth_complete Any clarity would be greatly appreciated.

sam_ofloinn · ‎11-06-2019

Robert, It's using an API token bound to my account, indeed. I would like to use OAuth, and the best way I know how is with the Laravel library "Passport", but there seems to be no documentation on configuring it with Canvas. So I'm very confused on how they should interact.

Post Details	Date Published	Views	Kudos
Canvas cURL pagination: doesn't include "last" page link? For my project I need to get all the pages of data for a project. I can make cURL requests on data endpoints and get all the pages I want. For example, see this DD of some page data that includes ...	01-20-2020	1037	0
Find a Course by SIS Course ID, when given only part of that SIS ID? In my custom application, I have a program that successfully searches for and finds a course when given its SIS Course ID. Using this code written in PHP Laravel: $sis_course_id = $request->sis_...	12-03-2019	3565	2
How do I find a course by name? My current project asks me to develop a webpage that allows someone to find a single course, if given its name or ID. Let's say name, for now. To that end, I'm following the official documentati...	11-27-2019	1270	1
Find user in Canvas if given their name? I'm creating a custom web application for my university that allows users to search for a single user in Canvas. I've studied the documentation here: https://canvas.instructure.com/doc/api/users.h...	11-25-2019	887	2
Is it possible to create a new Canvas page? I'm developing a new application for Canvas, and I just want to verify one thing. Is it possible to program a new webpage on my server, https://my.instructure.com, using a text editor or other materi...	11-15-2019	666	1
How to use Developer Key for OAuth2 Authentication? So I'm the admin of a Canvas test server, and want to set up OAuth2 authentication for my webpage. I've generated a developer key after logging into "https://my.test.instructure.com" and setting up ...	11-13-2019	5101	2
OAuth2 Authentication: unknown client in Canvas? I'm developing an OAuth2 Authentication client-server program using Laravel. My code looks like this: Route::get('/hi', function() { // Build the query parameter string to pas...	11-12-2019	4514	1
Why does "api/v1/users/self" refer to only the same account every time? In Laravel, I'm creating my own page, where I want to check if the user is a Canvas admin. If so, they have permission to see the page. Else, they're redirected. In each case, both pages reveal the f...	11-05-2019	1517	2
Can I check each of my courses for a certain folder more efficiently than this? Hi, I am checking all the courses in my Canvas database to see which ones have a certain folder. Let's call this folder "BB_Direct." At the moment, using cUrl requests like below, I check the acc...	04-08-2019	1162	1
How should I check a text file to see if it has a new course for my Canvas project? Hi, I hope this is the right place to ask. I have a "courses.txt" which contains the courses for my Canvas community. This will have new classes added to it as time goes on, and I want a way to ...	03-19-2019	920	3
PHP Pagination - buttons? Hi, I'm struggling with working pagination in PHP. According to the documentation, I can use those links to go to the next page of the collected results. I can put out a certain amount of ...	02-07-2019	1855	2

Posts	70
Solutions	1
Kudos given	55
Kudos received	31
Member Since	‎01-16-2019

Community

Have a Canvas Question?

Have a Mastery Question?

Have an Elevate Question?

Have an Impact Question?

Canvas cURL pagination: doesn't include "last" pag...

Re: How to use Developer Key for OAuth2 Authentica...

Re: How to use Developer Key for OAuth2 Authentica...

Re: Find a Course by SIS Course ID, when given onl...

Re: Find a Course by SIS Course ID, when given onl...

Re: Find a Course by SIS Course ID, when given onl...

Re: Find a Course by SIS Course ID, when given onl...

Re: Find a Course by SIS Course ID, when given onl...

Find a Course by SIS Course ID, when given only pa...

How do I find a course by name?

Re: Find user in Canvas if given their name?

Find user in Canvas if given their name?

Is it possible to create a new Canvas page?

Re: How to use Developer Key for OAuth2 Authentica...

Re: How to use Developer Key for OAuth2 Authentica...

How to use Developer Key for OAuth2 Authentication...

OAuth2 Authentication: unknown client in Canvas?

Re: OAuth Invalid/Unknown Client Error

Re: All things API

Re: Why does "api/v1/users/self" refer to only the...

Canvas Developers Group