Sensei: WordPress REST API Support

[georgestephanis]

What sort of functionality would be useful for inclusion in Sensei to support the REST API?

Possibilities:
Administrative tasks such as viewing student progression, quiz results, and such.
Administrators scoring open-ended responses in quizzes.
Serving up content and quizzes and options to students via the REST API and accepting submissions back likewise -- enabling courses to be taken on a Mobile App or the like.
???

[jeffikus]

Hey George - I actually prototyped up an iOS app during WooConf in 2014 for Sensei - it was barebones but was a good example of all the key areas that you would need for a student. I'll try and find it for you. I made a video somewhere of it so will try find it and post here.

[dwainm]

It would be nice to expose the following data/actions via the API:

Data
Student related:

• Courses: taken, completed/in-progress
• Lesson: complete/in-progress, quiz grade
• Quiz/Question: answers submitted, answer grades, question grade

Content related:

• Course: lessons, pre-requisites, next course in category
• Lesson: quiz url, lesson settings, requirements for completion.

Actions

• add/remove course users
• submit user question answer
• learner complete lesson
• reset learner lesson

I'm sure there are many other use cases which we can cover here, but these were just a few that came to mind. I guess we should start building the client to figure out exactly what one might need.

[jeffikus]

Found it! :) @dwainm @kevinbates and I had a hackathon team together on this.

[PederSongedal]

Dwain has a good summary of what we need.

We want to get the information regarding progress and completion of the course inn to an another system. This is the same system we want to ad users and assign courses from.

I wood also like the ability to get out as much data and statistics about the course and users as possible. Just to get all this info into a log file and in to Splunk for analysing who'd be nice.

[PederSongedal]

Nice @jeffikus

An IOS app is something we have been wanting for a long time, but never got the time to start with. And it can be as barebone as this, and still function good for the user. Keep me informed if you are planning to work on this, we may want to contribute.

Peder

[PederSongedal]

I also hope we can get the info from Sensei Content Drip and follow up email so we can trigger actions.

[jeffikus]

@PederSongedal sure, it was heavy alpha, but I think it should be rebuilt in more current tech to be honest - Cordova itself has changed a lot since I built it, but yeah I guess it could be a cool community project!

[luisrock]

Everything that would allow a student to watch lessons (and answer quizzes, download attached media, send message to teacher) on iOS or Android. We need to be able to get full benefit of WP REST API.

[donnapep]

We're starting to build out a REST API for Sensei (currently experimental). I'm going to close this issue though since the API will be iterated on over time. We'll be sure to reference this issue when deciding what to add to the REST API next. Cheers!

[prathyakshun]

When will the RESTAPI be built?

[donnapep]

When will the RESTAPI be built?

@prathyakshun We don't have a deadline that we're working toward at this point. Right now we're focused on fixing bugs and making smaller enhancements, before moving on to work on larger enhancements like the REST API.

[donnapep]

For anyone who is interested in testing the API out, if you add define( 'SENSEI_FEATURE_FLAG_REST_API_V1', true); to your wp-config.php file, you'll be able to navigate to https://your-domain/wp-json/sensei/v1 to see what endpoints we've implemented (currently course, module and version).

Note that this is an experimental API and we don't recommend using it on a Production site.

[pelcomppl]

Hi @donnapep
Is there any news about REST API?
Is it ready now?

[jenhooks]

Inquiry about Sensei on Android devices here, for tracking purposes. 1270919-zen

[jonalex]

Is there anything close to a documentation on how to use this API. Trying to sync it with a VR simulation. I need to handle logins, leader board get and user score put.

[donnapep]

Sensei doesn't have a full API and I wouldn't rely on the work done here. For now, you'll need to rely on whatever data the WordPress REST API returns.