In this article, I’ll provide some first guidance in using our API. We don’t currently aim for this to be used outside of the FeedbackFruits application itself, so for external parties, there might be some rough edges. If at any point this article is unclear, or you’d like to find out about other API endpoints, you can simulate the user & data flow by using the application with the Developer Inspector in the browser, as our frontend works with the same backend and type of requests.

Our API is a fairly standard RESTful JSON API. The requests below are using our EU environment, but you can use a different environment as explained. You can interact with the UI, although you won’t find the courses created through the LMS there.

We’d like to ask you to follow best practices when it comes to API usage, limiting repeated requests and not fetching the same data more than once per 10min when done in an automated fashion.

Depending on the region in which your data is hosted, you need to use the right endpoint to retrieve an access token & refresh token:

To retrieve an initial access token & refresh token on behalve of the user, you can use the password grant flow:

curl -XPOST https://accounts.feedbackfruits.com/auth/token

-H 'Content-Type: application/x-www-form-urlencoded'

-H 'Authorization: Basic ...'

-d 'grant_type=password&username=...&password=...&scope=...'

The access token is valid for an hour, the refresh token is valid for two weeks. To request a new access token & refresh token, you can use the following request:

curl -XPOST https://accounts.feedbackfruits.com/auth/token

-H 'Authorization: Basic ...'

-d 'grant_type=refresh_token&refresh_token=...'

The basic authorization header has to be composed following basic auth standards with a client_id and client_secret combination that we create for you on request.

Depending on the region in which your data is hosted, you need to use the right endpoint to fetch data from:

The FeedbackFruits API follows the JSON API standard.

To fetch the current user and its USER_ID using the API, you can make this request:

curl 'https://api.feedbackfruits.com/v1/users/current' -H 'Authorization: Bearer XXX'

To retrieve the courses with FeedbackFruits contents this user has access to, you can request them like:

curl 'https://api.feedbackfruits.com/v1/lti/courses' -H 'Authorization: Bearer XXX' -H 'Accept: application/vnd.api+json'

To retrieve the learning activities within a course, add the course id as found through the last request in the next request:

curl 'https://api.feedbackfruits.com/v1/activities?course_id=COURSE_ID' -H 'Authorization: Bearer XXX' -H 'Accept: application/vnd.api+json'

To retrieve the progress as shown in the table on top of a learning activity, you can request them as such:

curl 'https://api.feedbackfruits.com/v1/progresses?activity_id=ACTIVITY_ID' -H 'Authorization: Bearer XXX' -H 'Accept: application/vnd.api+json'

(If you’d like more detailed data, for example for a specific task, as found in the activities request, you can change activity_id= to task_id= and provide the task id).

Within the response JSON objects, you’ll find references to relationships that might be worth exploring the data from.

While our abilities to provide detailed documentation at this time are limited, if you have any questions, don’t hesitate to reach out!