Για να μπορέσετε να χρησιμοποιήσετε το api θα πρέπει πρώτα να δημιουργήσετε ένα authentication token. Η δημιουργία του γίνεται μέσα από το διαχειριστικό περιβάλλον της πλατφόρμας. Οδηγίες μπορείτε να βρείτε στο Δημιουργία API token.
Σε όλα τα παρακάτω υποθέτουμε ότι το url του eclass είναι το eclass.localdomain, ενώ όπου αναφέρεται ο κωδικός μαθήματος, θεωρούμε ότι είναι το TEST100.
Σημειώστε ότι σε περίπτωση επιτυχίας επιστρέφεται το αντίστοιχο json object, ενώ επιστρέφεται σχετικό μήνυμα λάθους σε περίπτωση αποτυχίας.
Παράδειγμα κλήσης
curl -H 'Authorization: Bearer (eclass_token) ' 'https://eclass.localdomain/api/v1/courses/
'
Υποστηρίζονται οι παρακάτω κλήσεις.
Κλήσεις με GET
GET https://eclass.localdomain/api/v1/categories/
Επιστρέφει όλες τις σχολές - τμήματα.
GET https://eclass.localdomain/api/v1/courses/
Επιστρέφει όλα τα μαθήματα
GET https://eclass.localdomain/api/v1/courses/?course_id=TEST100
GET https://eclass.localdomain/api/v1/sections/?course_id=TEST100
Επιστρέφει τις ενότητες του μαθήματος με κωδικό=TEST100
GET https://eclass.localdomain/api/v1/groups/?course_id=TEST100
Επιστρέφει τις ομάδες χρηστών του μαθήματος με κωδικό=TEST100
GET https://eclass.localdomain/api/v1/groups/?group_id={N}
Επιστρέφει το όνομα της ομάδας χρηστών με group id=N
GET https://eclass.localdomain/api/v1/scorms/?scorm_id={N}
Επιστρέφει τα στοιχεία της γραμμής μάθησης με scorm_id=N
GET https://eclass.localdomain/api/v1/scorms/?course_id=TEST100
Επιστρέφει τις γραμμές μάθησης του μαθήματος με κωδικό=TEST100
GET https://eclass.localdomain/api/v1/scorms/?section_id={N}
Επιστρέφει τα στοιχεία της γραμμής μάθησης που συμμετέχουν στην ενότητα με section_id=N
GET https://eclass.localdomain/api/v1/scormtracking/?course_id=TEST100
Επιστρέφει τη βαθμολογία στις δραστηριότητες τύπου SCORM στις γραμμές μάθησης των χρηστών του μαθήματος με κωδικό TEST100
GET https://eclass.localdomain/api/v1/scormtracking/?group_id={N}
Επιστρέφει τη βαθμολογία στις δραστηριότητες τύπου SCORM στις γραμμές μάθησης των χρηστών της ομάδας με group_id=N
GET https://eclass.localdomain/api/v1/scormtracking/?course_id=TEST100&user_id={N}
Επιστρέφει τη βαθμολογία στις δραστηριότητες τύπου SCORM στις γραμμές μάθησης για τον χρήστη με user_id=N και μάθημα με κωδικό TEST100
GET https://eclass.localdomain/api/v1/scormtracking/?scorm_id={N}&user_id={N}
Επιστρέφει τη βαθμολογία στις δραστηριότητες τύπου SCORM στη γραμμή μάθησης με scorm_id=N για τον χρήστη με user_id=N
Κλήσεις με POST
POST https://eclass.localdomain/api/v1/users/
Δημιουργία χρήστη. Παράμετροι: username, firstname, lastname, emailaddress, [adt].
POST https://eclass.localdomain/api/v1/groups/
Δημιουργία ομάδας χρηστών. Παράμετροι course_id, groupname
POST https://eclass.localdomain/api/v1/enroll_user/
Εγγραφή χρήστη σε μάθημα. Παράμετροι: user_id, course_id, [role_id = {student|teacher|teacher_assistant}]
POST https://eclass.localdomain/api/v1/unenroll_user/
Απεγγραφή χρήστη από μάθημα. Παράμετροι: user_id, course_id
POST https://eclass.localdomain/api/v1/sso/
parameters: user_id