Hitelesítés

Miután megkapta az API-hoz szükséges hitelesítő adatokat (felhasználónév és jelszó), a login végpontot kell használni egy 1 órán át érvényes hitelesítési token generálásához. Ezzel a hitelesítési tokennel lehet nyers adatokat lekérni a többi végponton keresztül.

Minden óra elteltével új tokent kell generálni, hogy további nyers adatokat lehessen lekérni az AROBS TrackGPS rendszerből.

Hitelesítés alfejezet

Bejelentkezés

Általános leírás

A login végpontot a felhasználók API-ba történő hitelesítésére használjuk. A kérés törzsében egy felhasználónév és egy jelszó szerepel, és ha a hitelesítés sikeres, a rendszer egy hozzáférési tokent (JWT) és egy frissítő tokent ad vissza. Ezeket a tokeneket a védett API-erőforrásokhoz való hozzáféréshez kell használni.

⚠️ Minden kéréshez ehhez a végponthoz kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/authentication/login?api-version=2.0

Kérés paraméterei

A végponthoz küldött kéréseknek POST típusúnak kell lenniük, és tartalmazniuk kell:

  • Query paraméter:

    • api-version: az API verziója. Ajánlott érték: 2.0.

  • A payloadot a kérés törzsében form data-ként kell elküldeni a következő struktúrával:

{
  "username": "felhasznalo@example.com",
  "password": "TitkosJelszo123"
}

Tulajdonságok leírása

  • username: A bejelentkezéshez használt felhasználónév vagy e-mail cím.
  • password: A fiókhoz tartozó jelszó.

Válasz szerkezete

Sikeres válasz (HTTP 200) esetén a következő formátumot kapjuk:

{
    "access_token": "eyJhbGciOavJZdtmkv3s9OW4ljE2V225_uTkntrDo-SDYwFGgYLbpQ",
    "expires_in": 28800,
    "token_type": "Bearer",
    "refresh_token": "8E65181908146821C79E26259683DF6F-1",
    "scope": "CarPoolingAPI IdentityServerApi offline_access openid profile TrackGPSV4Api"
}

Tulajdonságok leírása

  • access_token: A JWT token, amelyet a további API-kérésekhez kell használni.
  • expires_in: A token érvényességi ideje másodpercben.
  • token_type: A token típusa, általában “Bearer”.
  • refresh_token: Token, amely a munkamenet újraindításához használható újra-hitelesítés nélkül.
  • scope: A tokenhez tartozó jogosultságok listája.

Hibaválaszok

  • 400 Bad Request – Hiányzó paraméterek vagy hibás kérési szerkezet.
  • 401 Unauthorized – Hibás hitelesítési adatok vagy inaktív felhasználó.
  • 429 Too Many Requests – Az aktuális felhasználó lekérdezési limitjének túllépése.