New Quizzes API is coming to REST

The content in this blog is over six months old, and the comments are closed. For the most recent product updates and discussions, you're encouraged to explore newer posts from Instructure's Product Managers.

TamasBalogh
Instructure Alumni
Instructure Alumni
4
2757

Blog Headers -- 2000 x 200 (4).png

As New Quizzes development continues, I’m pleased to share that our engineers have the development work for our Quiz Building API project underway once again. As you may recall, we shared earlier this year that focus would be on implementing the Rich Content Editor (RCE) and the API work would be on hold aside from the validation work being done with input from several customers and partners.  

For those that have been following our development, awaiting New Quizzes API endpoints, you will likely remember a post from one of our architects about Instructure moving toward GraphQL. You may also recall our request for response to a survey about your expectations of the API work and providing the option to share your feedback on the format - GraphQL or REST - to be used. Given the fact that New Quizzes had no API at that point in time and we were about to start implementing, coupled with a mixed response to our survey that showed many interested in and willing to learn the new GraphQL format, it made sense to start building in GraphQL so we’d be ahead of the game of changing all Canvas API to the new technology and preventing the need for our users and partners to implement their integrations twice in a short period of time. 

Given feedback received from both internal and external consumers of our APIs during our closed beta and validation sessions with the initial GraphQL APIs since that time, we have made the decision to pivot and implement the New Quizzes APIs in REST.  This will allow for faster access to APIs needed by our customers and partners in a format that all are more familiar with. 

As shared in our last quarterly updates for New Quizzes, we have more teams dedicated to the New Quizzes work, one of which will be focusing their full efforts on building out these new REST endpoints in Canvas. We are still committed to releasing in phases in order to bring value to you as soon as possible. The first phase of the API, the Quiz Building part will be available by the end of Q2 2023. You will be able to access the New Quiz data through these new endpoints similar to how you get data from existing canvas REST endpoints. As they are ready, documentation will be housed on api.instructure.com like the rest of the Canvas endpoints. 

The content in this blog is over six months old, and the comments are closed. For the most recent product updates and discussions, you're encouraged to explore newer posts from Instructure's Product Managers.

4 Comments
chriscas
Community Coach
Community Coach

Thanks for the fantastic news, @TamasBalogh!

I'm sure there are many people who are much more familiar with REST than GraphQL (myself included) who are delighted by this announcement.  I know the future is probably GraphQL, but from what I've found with just some rudimentary searches and a bit of playing around, switching from REST to GraphQL may require a pretty large rewrite of even my own simple scripts.  I'm glad that those of us who are more familiar with REST will have a path forward for New Quizzes, but I also look forward to workshops/trainings that Instructure may provide around GraphQL to help us transition in the future.

-Chris

SarahBlanton
Community Participant

I second what @chriscas said. I'm happy that I won't have to rewrite my scripts (for now) and try to keep track of which scripts need to use REST and which need to use GraphQL. Thank you, @TamasBalogh !

memrys
Community Participant

I just want an API as soon as possible... REST, GraphQL, whatever. The sooner we have the ability to automate the better. 😁

SemblatGuillaum
Community Explorer

When do you think the new REST API NEXT QUIZ will be available on beta version?