In this article, you can view a list of endpoints to gather data from Teach 'n Go using your school's API key.
How to Create Your API Key
Go to the School Settings Page.
Click on the Developers tab.
Create an API Key.
Using The API Key
There are two ways to use the API Key: pass it in the header or use it as a query parameter.
Header with X-API-KEY: key value
e.g. X-API-KEY:XXXXX
or
Query parameter apikey=keyvalue
Method: POST
Body: JSON
Request URLs
Below is the list of Endpoints you can retrieve data from:
Student List
Returns all your school's students and all relevant information.
https://app.teachngo.com/globalApis/student_list
Prospect List
Returns all your school's students and all relevant information.
https://app.teachngo.com/globalApis/prospect_list
Course List
Returns all your school's courses and all relevant information.
https://app.teachngo.com/globalApis/course_list
Lesson List
Returns a course's lessons and all relevant information. Use the course_id, which you can obtain by gathering the course list.
https://app.teachngo.com/globalApis/lesson_list/[course_id]
Student Attendance
Returns all information regarding student attendance.
https://app.teachngo.com/globalApis/students_attendance
Student Behaviours
Returns all information regarding student behaviour.
https://app.teachngo.com/globalApis/student_behaviours