REST API: olvasási végpontok
Az ingyenes Tutor LMS csak olvasható REST végpontjai: kurzusok, témák, leckék, bejelentések, kvízek, szerzők, értékelések és kurzustartalom.
Az ingyenes Tutor LMS csak olvasási jogot ad az API-hoz, és minden kéréshez hitelesítés kell (lásd REST API: áttekintés és hitelesítés). Az alábbi végpontok natív és külső alkalmazások kiszolgálására is alkalmasak. Az oldalad-cime.hu helyére a saját weboldalad címe kerüljön.
| Mit kérsz le | Cím (mind GET) | Paraméter |
|---|---|---|
| Kurzusok listája | https://oldalad-cime.hu/wp-json/tutor/v1/courses?order=&orderby=&paged=1&tags=cimke1,cimke2&categories=kategoria1,kategoria2 |
Nem kötelező, lapozható |
| Egy kurzus adatai | https://oldalad-cime.hu/wp-json/tutor/v1/courses/{course_id} |
Kötelező, szám |
| Egy kurzus témái | https://oldalad-cime.hu/wp-json/tutor/v1/topics?course_id={course_id} |
Kötelező, szám |
| Egy téma leckéi | https://oldalad-cime.hu/wp-json/tutor/v1/lessons?topic_id={topic_id} |
Kötelező, szám |
| Egy kurzus bejelentései | https://oldalad-cime.hu/wp-json/tutor/v1/course-annoucement/{course-id} |
Kötelező, szám |
| Egy téma kvízei | https://oldalad-cime.hu/wp-json/tutor/v1/quiz/{topic-id} |
Kötelező, szám |
| Egy kvíz kérdései és válaszai | https://oldalad-cime.hu/wp-json/tutor/v1/quiz-question-answer/{quiz-id} |
Kötelező, szám |
| A szerző adatai | https://oldalad-cime.hu/wp-json/tutor/v1/author-information/{author-id} |
Kötelező, szám |
| Egy kurzus értékelései | https://oldalad-cime.hu/wp-json/tutor/v1/course-rating/{course-id} |
Kötelező, szám |
| A kurzus tartalma | https://oldalad-cime.hu/wp-json/tutor/v1/course-contents/{course_id} |
Kötelező |
A bejelentések címében a course-annoucement írásmód szerepel, pontosan így kell megadni.
A kurzuslista paraméterei:
| Paraméter | Mit csinál |
|---|---|
order |
A rendezés iránya (asc vagy desc). |
orderby |
A rendezés alapja (például ID). |
paged |
A lapozás oldalszáma. |
tags |
Címkék szerinti szűrés, vesszővel elválasztva. |
categories |
Kategóriák szerinti szűrés, vesszővel elválasztva. |
Ne felejtsd, hogy a válasz tartalma a hozzáférési tokenhez tartozó felhasználó jogaitól függ: a kurzus tartalma például csak akkor jön vissza, ha a kurzus nyilvános, a felhasználó beiratkozott rá, vagy hozzáférő oktató vagy adminisztrátor.
Készült: