REST API áttekintés
Az LW LMS REST API-ja: a nyilvános lms/v1 végpontok, az admin API, a hitelesítés és a válaszok formátuma.
A tanulói felületed az lms/v1 REST API-ra épül. Három felület van:
| Felület | Útvonal | Kinek |
|---|---|---|
| Nyilvános tanulói API | /wp-json/lms/v1/… |
a frontendednek |
| Admin API | /wp-json/lw-lms/v1/admin/… |
LMS-kezelőknek, adminisztrátoroknak |
| Abilities | /wp-json/wp-abilities/v1/… |
WordPress 6.9-től |
Végpontok
Szekció neve “Végpontok”| Végpont | Ki hívhatja | Részletek |
|---|---|---|
GET /courses |
bárki | Kurzusok |
GET /courses/{id} |
bárki | Kurzusok |
GET /lessons/{id} |
akinek van hozzáférése | Leckék és kvízek |
POST /lessons/{id}/quiz |
bejelentkezett, hozzáféréssel | Leckék és kvízek |
GET /progress |
bejelentkezett | Haladás |
POST /progress |
bejelentkezett, hozzáféréssel | Haladás |
GET /progress/course/{id} |
bejelentkezett | Haladás |
GET /download/{id} |
aláírt linkkel vagy bejelentkezve | Leckék és kvízek |
Az alap URL: https://pelda.hu/wp-json/lms/v1/. Ha a szép permalinkek ki vannak kapcsolva: https://pelda.hu/?rest_route=/lms/v1/….
Hitelesítés
Szekció neve “Hitelesítés”- Külön frontend vagy alkalmazás: WordPress-alkalmazásjelszó HTTP Basic hitelesítéssel. A tanuló a Felhasználók → Profil → Alkalmazásjelszavak részen hozza létre.
- Ugyanazon a domainen futó téma: a bejelentkezési süti és az
X-WP-Noncefejléc (wp_restnonce).
A példák WordPress-alkalmazásjelszót használnak (-u "felhasználó:jelszó"). A tanulo:… a tanuló saját fiókja, az admin:… egy adminisztrátoré.
Válaszok
Szekció neve “Válaszok”- A válasz JSON. A lapozás adatai a válasz
metaobjektumában vannak, nem azX-WP-Totalfejlécben. - Hibánál:
{ "code": "…", "message": "…", "data": { "status": 4xx } }. Az üzenet a webhely nyelvén jön, magyar oldalon magyarul.