API Reference

REST API pro integraci s externími systémy a automatizaci.

Úvod

SW Portal poskytuje REST API pro programový přístup k datům a funkcím portálu. API používá JSON formát pro request i response.

Base URL

https://sw.opent2.com/api/v1

Autentizace

API používá Bearer token autentizaci. Token získáte přes login endpoint:

POST /auth/login

Přihlášení a získání API tokenu.

POST /api/v1/auth/login
Content-Type: application/json

{
    "email": "[email protected]",
    "password": "your-password"
}

Response:

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "user": {
        "id": 1,
        "name": "Jan Novák",
        "email": "[email protected]",
        "role": "teacher"
    }
}

Token používejte v hlavičce všech dalších požadavků:

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...

API je aktuálně ve vývoji. Dostupné endpointy a formát odpovědí se mohou změnit.

Endpointy

Uživatelé

GET /users/me

Získání informací o přihlášeném uživateli.

Třídy

GET /classrooms

Seznam tříd přihlášeného učitele.

GET /classrooms/{id}

Detail konkrétní třídy včetně seznamu studentů.

POST /classrooms

Vytvoření nové třídy.

Studenti

GET /classrooms/{id}/students

Seznam studentů ve třídě.

Předměty a lekce

GET /subjects

Seznam všech předmětů.

GET /subjects/{id}/lessons

Lekce v rámci předmětu.

Chybové odpovědi

API vrací standardní HTTP status kódy:

200 - Úspěch
201 - Vytvořeno
400 - Chybný požadavek
401 - Neautorizováno
403 - Zakázáno
404 - Nenalezeno
422 - Validační chyba
500 - Interní chyba serveru

            {
    "message": "Popis chyby",
    "errors": {
        "field": ["Validační zpráva"]
    }
}
        

Začínáme Changelog