README
Using teech.io API, developers can build state of the art education apps in hours and forget complex infrastructure.
- To start using the API, you’ll need to signup for a developer account here
- Add an application on your developer dashboard
Read the full docs at developer.teech.io
teech.io REST API is built around JSON encoding of data and a schemaless data structure. Working with a schemaless data structure means that, besides some required keys, you don’t need to define ahead of time what keys are on each object. You will set the key-value pairs you need and the backend will store them in the cloud within your object. There are ten resources that can be used through teech.io REST API to store different types of objects within your education app.
##OBJECTS
An object is the most generic resource that you can use. To create an object you only need a class name that you can use to distinguish different sorts of data. For example, we could create a leaderboard object an name it Leaderboard.
##USERS
User objects allow you to perform operations on users like signup and signin.
##MATERIALS
Material objects allow you to create different types of learning materials like quizzes or media.
##MODULES
Module objects are containers with a certain number of materials attached to them as assignments. For example, we could use modules to shape courses, lectures or sections or, if you are building an edutainment app for example, you could create game levels using modules. Furthermore, you can enroll users in a module.
##ENROLLMENTS
Enrollment objects allow you to enroll a user in a module and keep track of his enrollments.
##ASSESSMENTS
Assessment objects allow you to create rules that can be used later to evaluate users submissions to assignments. You can create how many assessment objects you need and later decide by wich assessment rule you want evaluate each assignment.
##ASSIGNMENTS
Assignment objects allow you to attach materials to modules and register students submissions. Using an assignment instead of registering student submissions directly to materials allows you to track students progress on a certain topic without having to duplicate the material.
##SUBMISSIONS
Submission objects allow you to assess students through the assignments and evaluate their performance.
##FILES
The files endpoint let you to store and retrieve binary files in teech.io cloud storage. The files are automatically enabled for download using a CDN (Content Delivery Network).