Nyilvános API

Tartalomjegyzék

Az AROBS TrackGPS API-val elérhető metódusok megtekintéséhez a következő lépéseket kell követni:

  1. Lépjen be az AROBS TrackGPS alkalmazásba, majd kattintson a „Fiókom” menüpontra
  2. Válassza a „Platform beállítások” lehetőséget
  3. Kattintson a „API Link” mezőben megjelenő linkre

Miután rákattint a „API Link” mezőben található linkre, a böngészőben egy új oldal nyílik meg Swagger néven, ahol további információkat talál az elérhető API metódusokról. Fontos, hogy a jobb felső sarokban válassza ki a „V2” webszolgáltatás verziót. Az oldal így néz ki: Swagger Swagger

Nyilvános API alfejezet

Általános információk

Az alkalmazásprogramozási felület (API) egy szoftveres interfész, amely lehetővé teszi két alkalmazás közötti interakciót a felhasználó beavatkozása nélkül. Az API funkciók és eljárások gyűjteménye. Egyszerűen fogalmazva, az API egy olyan szoftverkód, amely elérhető vagy végrehajtható. Az API-t úgy definiáljuk, mint egy kódot, amely segíti két különböző szoftver közötti kommunikációt és adatcserét.

diagram.png diagram.png

A webes API egy olyan alkalmazásprogramozási felület, amelyet vagy webszerverhez, vagy webböngészőhöz használnak.
Az API-nak 2 komponense van:

  • Szerveroldal (AROBS TrackGPS)
  • Ügyféloldal (Végfelhasználó)

Szerveroldal:
A webes API szerveroldala egy programozott interfész, amely egy vagy több, nyilvánosan elérhető végpontból áll egy meghatározott kérés-válasz (request-response) üzenetrendszerben. Az AROBS TrackGPS API REST típusú, amely az információkat (nyers adatokat) JSON formátumban adja vissza a meglévő metódusok használatával.

Ügyféloldal:
A végfelhasználó képes lesz a nyers adatokat kinyerni (a fent említett metódusok használatával), és azokat különböző alkalmazásokban, jelentésekben és/vagy funkciókban felhasználni.

Kéréslimitek

Kéréslimitek a TrackGPS REST API-hoz

A TrackGPS REST API alapértelmezett kérésszámlimitet alkalmaz a szolgáltatás teljesítményének és stabilitásának biztosítása érdekében. Jelenleg a limit 30 másodpercenként 1 kérés. Ez azt jelenti, hogy minden felhasználó 30 másodpercenként egyetlen kérést küldhet az API-hoz.

Kivétel: A bejelentkezési végpont nem esik ezen limit alá, és korlátozás nélkül elérhető.

A TrackGPS REST API kérésszámlimitjének túllépése

Ha a 30 másodpercenként 1 kérés limitet túllépik, a szerver HTTP 429-es státuszkódot (Too Many Requests) ad vissza. Ez a kód azt jelzi, hogy a felhasználó túl sok kérést küldött rövid időn belül.

A státuszkód mellett a felhasználók specifikus hibaüzenetet is kapnak.

Javasoljuk, hogy a felhasználók várjanak, mielőtt további kéréseket küldenének, hogy elkerüljék ezt a hibakódot.

Kéréslimitek módosítása

Bizonyos esetekben, ha szükséges a kérésszámlimit módosítása, kérjük, vegye fel a kapcsolatot az ügyfélszolgálattal a lehetséges opciók megbeszéléséhez.

API felhasználó létrehozása

A felhasználó hitelesítéséhez szükség van egy felhasználónévre és jelszóra. Az API-hoz tartozó bejelentkezési adatok nem egyeznek meg az AROBS TrackGPS flottakezelő platform bejelentkezési adataival, ezért külön API felhasználókat kell létrehozni. Az API felhasználók létrehozása közvetlenül az AROBS TrackGPS webes platformján keresztül történhet az alábbi lépések szerint:

  1. Nyisd meg az AROBS TrackGPS alkalmazást, és a bal oldali menüből válaszd az „Adminisztráció”, majd az „E-mail címek” lehetőséget.step1.jpg step1.jpg
  2. A megnyíló ablakban kattintson az „E-mail hozzáadása” gombra (az ablak jobb alsó sarkában).step2.jpg step2.jpg
  3. Lépjen be az AROBS TrackGPS alkalmazásba, majd a bal oldali menüből válassza az „Adminisztráció” menüpontot, majd a „Felhasználók”-at! step1.png step1.png
  4. A megnyíló ablakban kattintson a „Hozzáadás” gombra (az ablak jobb alsó sarkában)! step2.png step2.png
  5. A „Hozzáadás” gomb megnyomása után egy új ablak jelenik meg, ahol új felhasználó hozható létre. API felhasználó létrehozásához jelölje be a „API felhasználó” négyzetet a Felhasználó adatai résznél, ezután néhány opció, mint például a „Jogosultságok sofőrökre” vagy „Jogosultságok felhasználókra” el lesz rejtve. A „Felhasználó adatai” ablakban csak 4 információt kell kitölteni: • Felhasználónév – ez lesz az API hitelesítéshez használt név • Keresztnév – a felhasználó azonosításához • Vezetéknév – a felhasználó azonosításához • Email – a felhasználóhoz tartozó email cím, amelyre az aktiváló email érkezik és ahol a jelszó beállítható

Figyelmeztetés: Ezzel a felhasználóval nem fog tudni bejelentkezni az AROBS TrackGPS felületére. Továbbá, az a felhasználó, ahol nincs bejelölve az „API felhasználó” opció, nem lehet APIs adatok kinyerésére felhasználni. step3.png step3.png

  1. Miután kitöltötte a „Felhasználó adatai” mezőket, válassza ki azokat a járműveket, amelyekhez API hozzáférést szeretne adni. A kiválasztás a „Jogosultságok járművekre” opcióval, majd a szükséges járművek bejelölésével történik, ahogy az alábbi képen látható: step4.png step4.png
  2. Ha minden szükséges adat (felhasználó adatai és jármű kiválasztás) ki van töltve, kattintson a „Mentés” gombra! step8.png step8.png
  3. Amint a gombot megnyomta és minden adat helyesen lett kitöltve, a felhasználó elmentésre kerül, és aktiváló emailt kap. Ellenőrizheti a felhasználók listájában, hogy az új felhasználónál be van-e jelölve az API felhasználó oszlop. step5.png step5.png
  4. Miután az aktiváló email megérkezett a felhasználó email címére, kattintson az „Fiók aktiválása” gombra. step6.png step6.png A gomb megnyomása után egy jelszóbeállító oldal nyílik meg, ahogy az alábbi képen látható: step7.png step7.png
  5. Adja meg a kívánt jelszót, amelynek tartalmaznia kell:
    • Legalább 8 karaktert
    • Legalább egy kisbetűt
    • Legalább egy számot
    • Legalább egy nagybetűt
  6. Végül kattintson a „Mentés” gombra, ezután a felhasználó készen áll az API adatok elérésére.

API Módszerek

API Módszerek Dokumentációja

Ráta limit: Minimum 30 másodperc két egymást követő kérés között, vagy a felhasználó számára meghatározott limit szerint.

Hitelesítés

Módszer URL Leírás
POST https://api.trackgps.ro/api/authentication/login?api-version=2.0 Bejelentkezés

Járművek

Az API lehetővé teszi a járművekre vonatkozó nyers adatok lekérését a következő végpontokon keresztül:

Módszer URL Leírás
GET https://api.trackgps.ro/api/carriers/company-vehicles?api-version=2.0 Járművek listázása
POST https://api.trackgps.ro/api/carriers/way?api-version=2.0 Útvonal adatok
POST https://api.trackgps.ro/api/carriers/stops?api-version=2.0 Megállók lekérdezése
POST https://api.trackgps.ro/api/carriers/consumption?api-version=2.0 Fogyasztási adatok
POST https://api.trackgps.ro/api/carriers/refills?api-version=2.0 Tankolási adatok
POST https://api.trackgps.ro/api/carriers/temperatures?api-version=2.0 Hőmérsékleti adatok

e-Transport

Az API lehetővé teszi a fuvarok kezelését a vállalat fiókjából a következő végpontokon keresztül:

Módszer URL Leírás
POST https://api.trackgps.ro/api/eTransport/add-transport?api-version=2.0 Új fuvar hozzáadása
POST https://api.trackgps.ro/api/eTransport/update-transport?api-version=2.0 Fuvar frissítése
POST https://api.trackgps.ro/api/eTransport/load-transports?api-version=2.0 Fuvarok lekérése
POST https://api.trackgps.ro/api/eTransport/remove-transports?api-version=2.0 Fuvarok törlése
POST https://api.trackgps.ro/api/eTransport/start-transports?api-version=2.0 Fuvar indítása
POST https://api.trackgps.ro/api/eTransport/end-transports?api-version=2.0 Fuvar befejezése
POST https://api.trackgps.ro/api/eTransport/pause-transports?api-version=2.0 Fuvar szüneteltetése

API Módszerek alfejezet

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.

Járművek

Jelenleg az AROBS TrackGPS által biztosított API lehetővé teszi 5 végpont használatát nyers adatok lekérésére:

Módszer URL Leírás
GET https://api.trackgps.ro/api/carriers/company-vehicles?api-version=2.0 Járművek listázása
POST https://api.trackgps.ro/api/carriers/way?api-version=2.0 Útvonal adatok
POST https://api.trackgps.ro/api/carriers/stops?api-version=2.0 Megállók lekérdezése
POST https://api.trackgps.ro/api/carriers/consumption?api-version=2.0 Fogyasztási adatok
POST https://api.trackgps.ro/api/carriers/refills?api-version=2.0 Tankolási adatok
POST https://api.trackgps.ro/api/carriers/temperatures?api-version=2.0 Hőmérsékleti adatok

Két egymást követő lekérdezés között legalább 30 másodpercnek kell eltelnie.

Járművek alfejezet

Céges járművek

Általános leírás

A CompanyVehicles metódus visszaadja a járművek listáját és azok részleteit. Csak azokat a járműveket adja vissza, amelyekhez a felhasználónak hozzáférése van.
A válaszban található vehicleId értékek később felhasználhatók az API további metódusainak meghívásához.

A metódus a Rate Limit korlátozásai alá esik.

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

⚠️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Válasz szerkezete

{
  "payload": [
    {
      "vehicleId": 0,
      "vehicleUId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "vehicleName": "string",
      "vehicleRegistrationNumber": "string",
      "latitude": 0,
      "longitude": 0,
      "gpsDate": "2024-09-09T08:52:55.005",
      "address": "string",
      "speed": 0,
      "course": 0,
      "engineEvent": 0,
      "engineRpm": 0,
      "engineEventDate": "2024-09-09T08:52:55.005",
      "serverDate": "2024-09-09T08:52:55.005",
      "isPrivate": true,
      "vehicleIdentificationNumber": "string",
      "externalPowerVoltage": 0,
      "vehicleManufacturer": "string",
      "vehicleModel": "string",
      "manufactureYear": 0
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

  • payload: A járművek listája és azok részletei.
    • vehicleId: A jármű egyedi azonosítója.
    • vehicleUId: A jármű univerzális egyedi azonosítója.
    • vehicleName: A jármű neve.
    • vehicleRegistrationNumber: A jármű rendszáma.
    • latitude: A jármű helyzetének szélességi foka.
    • longitude: A jármű helyzetének hosszúsági foka.
    • gpsDate: Az utolsó GPS-frissítés dátuma és ideje.
    • address: A jármű helyének címe.
    • speed: A jármű sebessége.
    • course: A jármű haladási iránya.
    • engineEvent: Motor esemény.
    • engineRpm: Motor fordulatszáma.
    • engineEventDate: A motor eseményének dátuma és ideje.
    • serverDate: A szerver válaszának dátuma és ideje.
    • isPrivate: Jelzi, hogy a jármű privát módban van-e.
    • vehicleIdentificationNumber: A jármű azonosító száma (VIN).
    • externalPowerVoltage: Tápfeszültség.
    • vehicleManufacturer: A jármű gyártója.
    • vehicleModel: A jármű modellje.
    • manufactureYear: A jármű gyártási éve.
  • correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
  • failureReasons: Hibák listája, ha vannak.
    • errorCode: Hibakód.
    • errorParameters: Hibához tartozó további paraméterek.
  • isSuccess: Jelzi, hogy a kérés sikeresen feldolgozásra került-e.

Útvonal

Általános leírás

A Way metódus visszaadja a járművek helyzetét a megadott időszakban. Csak azokat a járműveket adja vissza, amelyekhez a felhasználónak hozzáférése van. A metódus legfeljebb 10 vehicleId-t és maximum 31 napos időszakot fogad el paraméterként.

A Rate Limit korlátozásai érvényesek.

⚠️ 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/carriers/way?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Request paraméterek

{
  "vehiclesList": [
    0
  ],
  "startDate": "2024-09-09T09:21:50.133",
  "endDate": "2024-09-09T09:21:50.133"
}
  • vehiclesList: Azoknak a járműveknek az vehicleId listája, amelyek helyzetét le szeretné kérdezni.
  • startDate: Az időszak kezdő dátuma és ideje, amelyre a helyzetadatokat kéri.
  • endDate: Az időszak záró dátuma és ideje, amelyre a helyzetadatokat kéri.

Válasz szerkezete

{
  "payload": [
    {
      "vehicleId": 0,
      "gpsDate": "2024-09-09T09:21:50.134",
      "latitude": 0,
      "longitude": 0,
      "speed": 0,
      "course": 0
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

  • payload: A járművek helyzetének listája.
    • vehicleId: A jármű egyedi azonosítója.
    • gpsDate: Az utolsó GPS-frissítés dátuma és ideje.
    • latitude: A jármű földrajzi szélessége.
    • longitude: A jármű földrajzi hossza.
    • speed: A jármű sebessége.
    • course: A jármű haladási iránya.
  • correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
  • failureReasons: A hibák listája, ha vannak.
    • errorCode: Hibakód.
    • errorParameters: További paraméterek a hibához.
  • isSuccess: Jelzi, hogy a kérés sikeresen feldolgozásra került-e.

Megállások

Általános leírás

A Stops metódus visszaadja a járművek megállásainak listáját a lekérdezés időszakára vonatkozóan. Csak azoknak a járműveknek az adatait adja vissza, amelyekhez a felhasználónak hozzáférése van. Ha a lista tartalmaz legalább egy olyan járművet, amelyhez a felhasználónak nincs hozzáférése, akkor 401 hibakódú válasz érkezik.

A Rate Limit korlátozásai érvényesek.

⚠️ 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/carriers/stops?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Request paraméterek

{
  "vehiclesList": [
    0
  ],
  "startDate": "2024-09-09T09:49:19.549",
  "endDate": "2024-09-09T09:49:19.549",
  "stationaryMargin": 0
}
  • vehiclesList: Azon járművek azonosítóinak listája, amelyek megállásaira vonatkozik a lekérdezés (legfeljebb 10 jármű).
  • startDate: A lekérdezés kezdő dátuma és időpontja.
  • endDate: A lekérdezés záró dátuma és időpontja.
  • stationaryMargin: A megállás minimális időtartama percben (nem lehet kevesebb, mint 1 perc).

Válasz szerkezete

{
  "payload": [
    {
      "results": {
        "additionalProp1": [
          {
            "vehicleId": 0,
            "startDate": "2025-04-11T14:33:30.175",
            "endDate": "2025-04-11T14:33:30.175",
            "latitude": 0,
            "longitude": 0,
            "stationaryEngineOnTime": 0,
            "distance": 0,
            "maxSpeed": 0,
            "averageSpeed": 0,
            "speedCount": 0,
            "indexKm": 0,
            "indexHours": 0,
            "address": "string",
            "stopDuration": 0,
            "engineOnStops": [
              {
                "startDate": "2025-04-11T14:33:30.175",
                "endDate": "2025-04-11T14:33:30.175",
                "duration": 0
              }
            ],
            "hotSpot": "string",
            "functioningTime": 0,
            "isPrivate": true,
            "drivers": [
              {
                "firstName": "string",
                "lastName": "string"
              }
            ],
            "fuelConsumption": 0
          }
        ],
        "additionalProp2": [
          {
            "vehicleId": 0,
            "startDate": "2025-04-11T14:33:30.175",
            "endDate": "2025-04-11T14:33:30.175",
            "latitude": 0,
            "longitude": 0,
            "stationaryEngineOnTime": 0,
            "distance": 0,
            "maxSpeed": 0,
            "averageSpeed": 0,
            "speedCount": 0,
            "indexKm": 0,
            "indexHours": 0,
            "address": "string",
            "stopDuration": 0,
            "engineOnStops": [
              {
                "startDate": "2025-04-11T14:33:30.175",
                "endDate": "2025-04-11T14:33:30.175",
                "duration": 0
              }
            ],
            "hotSpot": "string",
            "functioningTime": 0,
            "isPrivate": true,
            "drivers": [
              {
                "firstName": "string",
                "lastName": "string"
              }
            ],
            "fuelConsumption": 0
          }
        ],
        "additionalProp3": [
          {
            "vehicleId": 0,
            "startDate": "2025-04-11T14:33:30.175",
            "endDate": "2025-04-11T14:33:30.175",
            "latitude": 0,
            "longitude": 0,
            "stationaryEngineOnTime": 0,
            "distance": 0,
            "maxSpeed": 0,
            "averageSpeed": 0,
            "speedCount": 0,
            "indexKm": 0,
            "indexHours": 0,
            "address": "string",
            "stopDuration": 0,
            "engineOnStops": [
              {
                "startDate": "2025-04-11T14:33:30.175",
                "endDate": "2025-04-11T14:33:30.175",
                "duration": 0
              }
            ],
            "hotSpot": "string",
            "functioningTime": 0,
            "isPrivate": true,
            "drivers": [
              {
                "firstName": "string",
                "lastName": "string"
              }
            ],
            "fuelConsumption": 0
          }
        ]
      }
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

  • payload: A járművek megállásainak listája.
    • results: Járművekhez tartozó megállások.
      • vehicleId: A jármű azonosítója.
      • startDate: A megállás kezdő dátuma és időpontja.
      • endDate: A megállás záró dátuma és időpontja.
      • latitude: A megállás helyének szélességi foka.
      • longitude: A megállás helyének hosszúsági foka.
      • stationaryEngineOnTime: A járó motorral való megállás idotartama.
      • distance: Megtett távolság.
      • maxSpeed: Elért maximális sebesség.
      • averageSpeed: Átlagsebesség.
      • speedCount: Sebességmérések száma.
      • indexKm: Kilométer index.
      • indexHours: Óra index.
      • address: A megállás helyének címe.
      • stopDuration: A megállás időtartama.
      • engineOnStops: Motor járása közbeni események listája.
        • startDate: A motor járása közbeni megállás kezdete.
        • endDate: A motor járása közbeni megállás vége.
        • duration: A motor járása közbeni megállás időtartama.
      • hotSpot: Hotspot neve, ha a megállás egy előre definiált hotspotban történt.
      • functioningTime: Működési idő.
      • isPrivate: Jelzi, hogy a megállás privát-e.
      • drivers: Sofőrök listája.
        • firstName: Sofőr keresztneve.
        • lastName: Sofőr vezetékneve.
      • fuelConsumption: Üzemanyag-fogyasztás az előző megállás végétől a jelenlegi megállásig valamint a jelenlegi megállás alatt (ha a motor járt).
  • correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
  • failureReasons: Hibák listája, ha vannak.
    • errorCode: Hibakód.
    • errorParameters: Hibához tartozó további paraméterek.
  • isSuccess: Jelzi, hogy a kérés sikeresen feldolgozásra került-e.

Fogyasztás

Általános leírás

A Consumption metódus információkat ad vissza egy jármű fogyasztásáról, megtett távolságáról, üzemóráiról, valamint az átlagfogyasztásról 100 km-re vetítve, az adott lekérdezési időszakra. A metódus legfeljebb 10 járműre és maximum 31 napos időszakra hívható meg. Ha a jármű LPG-vel is felszerelt, mindkét forrás adatai visszaadásra kerülnek.

A metódus a Rate Limit korlátozásai alá esik.

⚠️ 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/carriers/consumption?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

A kérés JSON szerkezete

{
  "vehiclesList": [
    0
  ],
  "startDate": "2024-09-09T07:15:14.124",
  "endDate": "2024-09-09T07:15:14.124"
}
Kérés tulajdonságai
  • vehiclesList: Azon járművek listája, amelyekre a lekérdezés történik (tömb, vehicleId típus).
  • startDate: A lekérdezési időszak kezdő dátuma.
  • endDate: A lekérdezési időszak záró dátuma.

A válasz JSON szerkezete

{
  "payload": [
    {
      "vehicleName": "string",
      "licensePlate": "string",
      "distance": 0,
      "hours": "string",
      "consumptionValue": 0,
      "averageConsumption100Km": 0,
      "secondarySource": {
        "distance": 0,
        "hours": "string",
        "consumptionValue": 0,
        "averageConsumption100Km": 0
      }
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}
Válasz tulajdonságai
Elsődleges tulajdonságok
  • vehicleName: A jármű neve (string típus).
  • licensePlate: Rendszám (string típus).
  • distance: Megtett távolság km-ben (numerikus típus).
  • hours: Üzemóra, időtartam formátumban óra:perc:másodperc (string típus).
  • consumptionValue: Fogyasztás értéke literben (numerikus típus).
  • averageConsumption100Km: Átlagfogyasztás 100 km-re vetítve, l/100km (numerikus típus).
Másodlagos forrás tulajdonságai
  • secondarySource.distance: Másodlagos forrás által megtett távolság km-ben (numerikus típus).
  • secondarySource.hours: Másodlagos forrás üzemórája, időtartam formátumban óra:perc:másodperc (string típus).
  • secondarySource.consumptionValue: Másodlagos forrás fogyasztása literben (numerikus típus).
  • secondarySource.averageConsumption100Km: Másodlagos forrás átlagfogyasztása 100 km-re vetítve, l/100km (numerikus típus).

Összesítések számítása

Ha a másodlagos forrás tartalmaz adatokat, az összesített értékekhez az elsődleges és másodlagos forrás adatait össze kell adni. Például:

{
  "payload": [
    {
      "vehicleName": "Jármű A",
      "licensePlate": "AB-12-BCD",
      "distance": 100,
      "hours": "10:00:00",
      "consumptionValue": 50,
      "averageConsumption100Km": 5,
      "secondarySource": {
        "distance": 50,
        "hours": "5:00:00",
        "consumptionValue": 20,
        "averageConsumption100Km": 4
      }
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "isSuccess": true
}

Összesítések:

  • distance: 100 + 50 = 150 km
  • hours: 10:00:00 + 5:00:00 = 15:00:00
  • consumptionValue: 50 + 20 = 70 liter
  • averageConsumption100Km: (5 + 4) / 2 = 4.5 l/100km

Tankolások

Általános leírás

A Refills metódus visszaadja a megadott időszakban észlelt tankolási vagy üzemanyagszint-csökkenési események listáját. Csak azokhoz a járművekhez tartozó adatokat adja vissza, amelyekhez a felhasználónak hozzáférése van.
Ha a lista legalább egy olyan járművet tartalmaz, amelyhez a felhasználónak nincs hozzáférése, 401 hibakódú válasz érkezik.

A Rate Limit korlátozásai érvényesek.

⚠️ 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/carriers/refills?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Request paraméterek

{
  "carrierId": 0,
  "startDate": "2024-09-09T09:42:51.835",
  "endDate": "2024-09-09T09:42:51.835"
}
  • carrierId: Annak a járműnek az egyedi azonosítója, amelyhez tankolási vagy üzemanyagszint-csökkenési eseményeket szeretnénk lekérni.
  • startDate: Az időszak kezdő dátuma és ideje, amelyre az eseményeket kérjük.
  • endDate: Az időszak záró dátuma és ideje, amelyre az eseményeket kérjük.

Válasz szerkezete

{
  "payload": [
    {
      "date": "string",
      "event": "string",
      "location": "string",
      "estimation": 0,
      "isPrivate": true
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

  • payload: A tankolási vagy üzemanyagszint-csökkenési események listája.
    • date: Az esemény dátuma és ideje.
    • event: Az esemény típusa (tankolás vagy üzemanyagszint-csökkenés).
    • location: Az esemény helyszíne.
    • estimation: Az eseményhez kapcsolódó üzemanyag mennyiségének becslése.
    • isPrivate: Jelzi, hogy az esemény magáncélú volt-e.
  • correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
  • failureReasons: A hibák listája, ha vannak.
    • errorCode: Hibakód.
    • errorParameters: Hibához tartozó további paraméterek.
  • isSuccess: Jelzi, hogy a kérés sikeresen feldolgozásra került-e.

Lehetséges eseménytípusok listája

  • FuelStart: Kezdő szint
  • Fueling: Tankolás
  • PossibleFuelTheft: Lehetséges üzemanyaglopás
  • TotalRefill: Összes tankolás
  • TotalPossibleTheft: Összes lehetséges üzemanyaglopás
  • RemainingFuel: Maradék üzemanyag
  • TotalFuelConsumption: Teljes üzemanyag-fogyasztás
  • FuelStartSecondarySource: Másodlagos forrás kezdő szintje
  • FuelingSecondarySource: Tankolás másodlagos forrásból
  • PossibleFuelTheftSecondarySource: Lehetséges üzemanyaglopás másodlagos forrásból
  • TotalRefillSecondarySource: Összes tankolás másodlagos forrásból
  • TotalPossibleTheftSecondarySource: Összes lehetséges lopás másodlagos forrásból
  • RemainingFuelSecondarySource: Maradék üzemanyag másodlagos forrásból
  • TotalFuelConsumptionSecondarySource: Teljes üzemanyag-fogyasztás másodlagos forrásból

Hőmérsékletek

Az Általános Módszer Leírása

A Temperatures metódus visszaadja a lekérdezés időszakára vonatkozó rögzített hőmérsékleti adatokat. Csak azokhoz a járművekhez ad vissza adatokat, amelyekhez a felhasználónak hozzáférése van. Ha a lista tartalmaz legalább egy olyan járművet, amelyhez a felhasználónak nincs hozzáférése, akkor 401 hibakódú válasz érkezik.

A Rate Limit korlátozásai érvényesek.

⚠️ 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/carriers/temperatures?api-version=2.0

⚠️️ Megjegyzés: Az ezen végponthoz küldött vagy onnan kapott minden dátum- és időérték a vállalat helyi időzónájában van megadva.

Kérés Paraméterei

{
  "vehiclesList": [
    0
  ],
  "startDate": "2024-09-09T09:49:19.549",
  "endDate": "2024-09-09T09:49:19.549"
}
  • vehiclesList: Azoknak a járműveknek a listája, amelyekhez hőmérsékleti adatokat kérünk.
  • startDate: Az időszak kezdő dátuma, amelyre az adatokat kérjük.
  • endDate: Az időszak záró dátuma, amelyre az adatokat kérjük.

Válasz Struktúrája

{
  "payload": [
    {
      "temperature": [
        {
          "vehicleId": 0,
          "date": "2025-04-11T12:33:11.817",
          "value": 0,
          "sensorNumber": 0
        }
      ],
      "humidity": [
        {
          "vehicleId": 0,
          "date": "2025-04-11T12:33:11.817",
          "value": 0,
          "sensorNumber": 0
        }
      ]
    }
  ],
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}
  • payload: Az eredményeket tartalmazza a hőmérsékleti adatokkal.
  • correlationId: Egyedi azonosító a kérés és válasz összekapcsolásához.
  • failureReasons: Azok az okok, amelyek miatt a kérés sikertelen volt, ha vannak ilyenek.
  • isSuccess: Jelzi, hogy a kérés sikeres volt-e.

e-Transport

Jelenleg az AROBS TrackGPS által biztosított API lehetővé teszi, hogy 7 végpontot használjon a vállalat fiókjában lévő fuvarok kezeléséhez:

Módszer URL Leírás
POST https://api.trackgps.ro/api/eTransport/add-transport?api-version=2.0 Új fuvar hozzáadása
POST https://api.trackgps.ro/api/eTransport/update-transport?api-version=2.0 Fuvar frissítése
POST https://api.trackgps.ro/api/eTransport/load-transports?api-version=2.0 Fuvar lekérése
POST https://api.trackgps.ro/api/eTransport/remove-transports?api-version=2.0 Fuvar törlése
POST https://api.trackgps.ro/api/eTransport/start-transports?api-version=2.0 Fuvar indítása
POST https://api.trackgps.ro/api/eTransport/end-transports?api-version=2.0 Fuvar befejezése
POST https://api.trackgps.ro/api/eTransport/pause-transports?api-version=2.0 Fuvar szüneteltetése

Két egymást követő kérés között legalább 30 másodpercnek kell eltelnie.

e-Transport alfejezet

Fuvar hozzáadása

Általános leírás

Az add-transport végpont lehetővé teszi egy új fuvar hozzáadását a rendszerhez. A felhasználó megadhatja a fuvarhoz kapcsolódó összes részletet, beleértve a hozzárendelt járművet, a kezdő és záró dátumokat, a helyszíneket, valamint további információkat, például a kapcsolódó pótkocsit.

A végpont a Rate Limit korlátozásai alá tartozik.

⚠️ Minden kéréshez kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/eTransport/add-transport?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 a következő paramétereket kell tartalmazniuk:

  • Query paraméter:

    • api-version (string, kötelező) – Az API verziója. Ajánlott érték: 2.0

  • Body (JSON):

{
  "vehicleUId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "startDate": "2025-04-09T07:38:24.380Z",
  "endDate": "2025-04-09T07:38:24.380Z",
  "codeUit": "string",
  "notes": "string",
  "startLocation": "string",
  "endLocation": "string",
  "vatNumber": "string",
  "validityStartDate": "2025-04-09T07:38:24.380Z",
  "validityEndDate": "2025-04-09T07:38:24.380Z",
  "trailer1Code": "string",
  "trailer2Code": "string"
}
Paraméter Típus Kötelező Leírás
vehicleUId string Igen A fuvarhoz tartozó jármű egyedi azonosítója.
startDate string Nem Az adatok ANAF platformára történő továbbításának kezdő dátuma és ideje (ISO 8601, UTC formátum).
endDate string Nem Az adatok ANAF platformára történő továbbításának záró dátuma és ideje (ISO 8601, UTC formátum).
codeUit string Igen Az ANAF által generált UIT kód.
notes string Nem További megjegyzések a fuvarhoz.
startLocation string Nem A fuvar kezdő helyszíne.
endLocation string Nem A fuvar végső helyszíne.
vatNumber string Igen A fuvarozó adószáma (CIF).
validityStartDate string Igen Az UIT kód érvényességének kezdő dátuma. Ezt az ANAF platform generálja (ISO 8601, UTC formátum).
validityEndDate string Igen Az UIT kód érvényességének záró dátuma. Ezt az ANAF platform generálja (ISO 8601, UTC formátum).
trailer1Code string Nem Az első pótkocsi rendszáma.
trailer2Code string Nem A második pótkocsi rendszáma.

🕒 Fontos: Minden dátum típusú mezőt (pl. startDate, endDate, validityStartDate, validityEndDate) UTC formátumban kell megadni.

Válasz szerkezete

{
  "payload": true,
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

Tulajdonság Típus Leírás
payload boolean Jelzi, hogy a fuvar sikeresen hozzá lett-e adva (true vagy false).
correlationId string A kérés azonosítója a válaszok összekapcsolásához.
failureReasons array Hibák listája (ha van), további részletekkel.
isSuccess boolean Jelzi, hogy a kérés sikeresen feldolgozásra került-e (true) vagy sem (false).

Hibaválaszok

HTTP kód Leírás
400 Hiányzó paraméterek vagy érvénytelen szerkezet.
401 Hibás hitelesítő adatok vagy jogosulatlan felhasználó.
429 A felhasználó túllépte a lekérdezési limitet.

Fuvar módosítása

Általános leírás

Az update-transport végpont lehetővé teszi egy már meglévő fuvar módosítását a rendszerben. Frissítheted például az időszakot, helyszíneket, megjegyzéseket vagy a pótkocsik adatait.

A Rate Limit korlátozásai érvényesek.

⚠️ Minden kéréshez kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/eTransport/update-transport?api-version=2.0

Kérés paraméterei

A végponthoz POST típusú kérést kell küldeni az alábbi paraméterekkel:

  • Query paraméter:

    • api-version (string, kötelező) – Az API verziója. Ajánlott érték: 2.0

  • Body (JSON):

{
  "transportUId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vehicleUId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "startDate": "2025-04-09T07:38:24.380Z",
  "endDate": "2025-04-09T07:38:24.380Z",
  "notes": "string",
  "startLocation": "string",
  "endLocation": "string",
  "vatNumber": "string",
  "validityStartDate": "2025-04-09T07:38:24.380Z",
  "validityEndDate": "2025-04-09T07:38:24.380Z",
  "trailer1Code": "string",
  "trailer2Code": "string"
}
Paraméter Típus Kötelező Leírás
transportUId string Igen A módosítandó fuvar azonosítója.
vehicleUId string Igen A fuvarhoz tartozó jármű azonosítója.
startDate string Nem Az adatszolgáltatás kezdő dátuma és ideje az ANAF platformon (ISO 8601, UTC formátum).
endDate string Nem Az adatszolgáltatás befejező dátuma és ideje az ANAF platformon (ISO 8601, UTC formátum).
validityStartDate string Igen A UIT kód érvényességének kezdete. Az ANAF platform generálja (ISO 8601, UTC formátum).
validityEndDate string Igen A UIT kód érvényességének vége. Az ANAF platform generálja (ISO 8601, UTC formátum).
notes string Nem További megjegyzések.
startLocation string Nem Indulási helyszín.
endLocation string Nem Érkezési helyszín.
vatNumber string Igen A fuvarozó adószáma (CIF).
trailer1Code string Nem Az első pótkocsi rendszáma.
trailer2Code string Nem A második pótkocsi rendszáma.

🕒 Fontos: A dátum típusú mezőket (startDate, endDate, validityStartDate, validityEndDate) UTC formátumban kell megadni.

Válasz szerkezete

{
  "payload": true,
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
  {
    "errorCode": "string",
    "errorParameters": [
    "string"
    ]
  }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

Tulajdonság Típus Leírás
payload boolean Jelzi, hogy a fuvar módosítása sikeres volt-e.
correlationId string A kérés egyedi azonosítója (nyomon követéshez, hibakereséshez).
failureReasons array Hibák listája (ha van), kódokkal és paraméterekkel.
isSuccess boolean Jelzi, hogy a kérés hibamentesen feldolgozásra került-e (true/false).

Hibaválaszok

HTTP kód Leírás
400 Hiányzó paraméter vagy hibás szerkezet.
401 Hibás hitelesítő adatok vagy jogosulatlan felhasználó.
429 A felhasználó túllépte a lekérési limitet.

Fuvarok listája

Általános leírás

A load-transports végpont arra szolgál, hogy a felhasználó fiókjában elérhető fuvarok listáját lekérje, a járművekhez való hozzáférési jogosultságok alapján. A felhasználó szűrő paramétereket is megadhat, például a fuvar státuszát vagy egy keresési kifejezést.

A végpont a Rate Limit korlátozásai alá esik.

⚠️ A fuvarok minden dátumadata, amely a válaszban megjelenik, a vállalat időzónájában van rögzítve, nem UTC-ben. Győződjön meg róla, hogy a fuvarokat a vállalat időzóna beállításainak megfelelően kezeli, amikor az adatokat lekéri a rendszerből.

⚠️ Minden kéréshez kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/eTransport/load-transports?api-version=2.00

⚠️ Azok a fuvarok, amelyek státusza “Hiba” és a mobil vagy webes alkalmazásban láthatók, ebből a végpontból nem kerülnek visszaadásra.

Kérés paraméterei

A végponthoz POST típusú kérést kell küldeni, az alábbi paraméterekkel:

  • Query paraméter:

    • api-version (string, kötelező) – Az API verziója. Ajánlott érték: 2.0

  • Body (JSON):

{
  "pageSize": 0,
  "pageIndex": 0,
  "statusIds": [
  1
  ],
  "searchValue": "string"
}
Paraméter Típus Kötelező Leírás
pageSize number Nem Az oldalon visszaadott elemek száma.
pageIndex number Nem Az oldal indexe a lekérdezéshez.
statusIds array Igen A keresett fuvar státuszok azonosítóinak listája.
searchValue string Nem Keresési szó vagy kifejezés a fuvarok listájában.

Fuvar státuszok listája

Id Leírás
1 Függőben
2 Folyamatban
3 Befejezett
4 Automatikusan lezárt
5 Hiba
6 Szünet

Válasz szerkezete

{
  "payload": {
  "totalRecords": 0,
  "transports": [
    {
    "uId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "carrierCode": "string",
    "carrierName": "string",
    "carrierUId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "trailer1Code": "string",
    "trailer2Code": "string",
    "codeUit": "string",
    "statusId": 0,
    "startDate": "2025-05-16T14:35:04.862Z",
    "endDate": "2025-05-16T14:35:04.862Z",
    "validityStartDate": "2025-05-16T14:35:04.862Z",
    "validityEndDate": "2025-05-16T14:35:04.862Z",
    "notes": "string",
    "startLocation": "string",
    "endLocation": "string",
    "externalId": 0,
    "externalResponse": "string",
    "lastSyncDate": "2025-05-16T14:35:04.862Z",
    "transmissionStatusCode": "string",
    "transmissionStatusErrorDescription": "string",
    "lastTransmissionDate": "2025-05-16T14:35:04.862Z",
    "lastGpsDate": "2025-05-16T14:35:04.862Z",
    "changeRequestMessage": "string",
    "changeRequestStatusCode": "string",
    "changeRequestCreatedAt": "2025-05-16T14:35:04.862Z",
    "changeRequestDate": "2025-05-16T14:35:04.862Z",
    "changeRequestAnafStatus": "string",
    "changeRequestAnafMessage": "string",
    "changeRequestAnafDate": "2025-05-16T14:35:04.862Z"
    }
  ]
  },
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
  {
    "errorCode": "string",
    "errorParameters": [
    "string"
    ]
  }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

Tulajdonság Típus Leírás
payload object Az objektum tartalmazza a visszaadott fuvarokat és egyéb releváns információkat.
totalRecords number Az elérhető fuvarok teljes száma.
transports array Az elérhető fuvarok listája, mindegyik saját részletes adatokkal.
uId string A fuvar egyedi azonosítója.
carrierCode string A jármű rendszáma, amelyet az ANAF-hoz történő helyadat-továbbításhoz használnak.
carrierName string A jármű neve, amelyet az ANAF-hoz történő helyadat-továbbításhoz használnak.
carrierUId string A jármű egyedi azonosítója.
trailer1Code string Az első pótkocsi rendszáma.
trailer2Code string A második pótkocsi rendszáma.
codeUit string Az ANAF által generált UIT kód.
statusId number A fuvar státusza.
startDate string Az ANAF platformján a GPS adatok továbbításának kezdete (dátum és idő).
endDate string Az ANAF platformján a GPS adatok továbbításának vége (dátum és idő).
validityStartDate string Az UIT kód érvényességének kezdete (ANAF generálja).
validityEndDate string Az UIT kód érvényességének vége (ANAF generálja).
notes string További megjegyzések a fuvarhoz.
startLocation string A fuvar indulási helye.
endLocation string A fuvar érkezési helye.
externalId number Az ANAF platformján a fuvar válaszának azonosítója.
externalResponse string Az ANAF platformjáról érkező válaszüzenet.
lastSyncDate string Az ANAF platformjáról történő fuvar átvételének dátuma.
transmissionStatusCode string GPS adatok ANAF platformra történő továbbításának státusza.
transmissionStatusErrorDescription string A GPS adatok továbbítási hibájának leírása az ANAF platformra.
lastTransmissionDate string Az utolsó GPS koordináta továbbításának dátuma az ANAF felé.
lastGpsDate string Az utolsó GPS koordináta fogadásának dátuma a járműtől.
changeRequestMessage string A fuvaradat-módosítási kérelem válaszüzenete.
changeRequestStatusCode string A fuvaradat-módosítási kérelem státusza.
changeRequestCreatedAt string A fuvaradat-módosítási kérelem létrehozásának dátuma.
changeRequestDate string Az ANAF platformról érkező válasz fogadásának dátuma a módosítási kérelemre.
changeRequestAnafStatus string Az ANAF platformról érkező fuvaradat-módosítási kérelem státusza.
changeRequestAnafMessage string Az ANAF platformról érkező fuvaradat-módosítási kérelem feldolgozásának válaszüzenete.
changeRequestAnafDate string Az ANAF platformról érkező fuvaradat-módosítási kérelem feldolgozásának dátuma.
correlationId string A kérés azonosítója a válaszok összekapcsolásához.
failureReasons array Hibák listája (ha van), további részletekkel.
isSuccess boolean Jelzi, hogy a kérés sikeresen feldolgozásra került-e (true) vagy sem (false).

GPS adatok ANAF platformra történő továbbításának státuszai

Kód Leírás
Active Aktív továbbítás
Finalized Lezárt továbbítás
NotInRomania Nincs Románia területén
NotStarted Továbbításra vár
Error Továbbítási hiba
MissingETransportConfiguration e-Transport konfigurációs hiba, kérjük, forduljon a támogatáshoz
OldData 6 óránál régebbi adatok
NoGPSCoordinates Nincs GPS jel
WithoutTransmission Nincs aktív GPS továbbítás

Fuvaradat-módosítási kérelmek státuszai

Kód Leírás
RequestCreated Kérelem létrehozva
RequestSent Kérelem sikeresen elküldve
RequestErrorSent Kérelem küldése sikertelen
ResponseSuccess Kérelem sikeresen lezárva
ResponseError Kérelem hibával lezárva

Hibaválaszok

HTTP kód Leírás
400 Hiányzó paraméterek vagy érvénytelen szerkezet.
401 Hibás hitelesítő adatok vagy jogosulatlan felhasználó.
429 A felhasználó túllépte a lekérdezési limitet.

Fuvarok törlése

Általános leírás

A remove-transports végpont lehetővé teszi egy vagy több fuvar törlését a rendszerből az egyedi azonosítók (transportUId) alapján. Ez a művelet visszavonhatatlan, és megfelelő jogosultságokat igényel az érintett fuvarokra.

A Rate Limit korlátozásai érvényesek.

⚠️ 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/eTransport/remove-transports?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 a következő paramétereket kell tartalmazniuk:

  • Query paraméter:

    • api-version (string, kötelező) – Az API verziója. Ajánlott érték: 2.0

  • Body (JSON):

{
  "transportsUids": [
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}
Paraméter Típus Kötelező Leírás
transportsUids tömb Igen Az egyedi fuvar azonosítók (GUID) listája, amelyeket törölni kell.

Válasz szerkezete

{
  "payload": true,
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
  {
    "errorCode": "string",
    "errorParameters": [
    "string"
    ]
  }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

Tulajdonság Típus Leírás
payload logikai A törlési művelet eredménye (true, ha sikeres volt).
correlationId string Egyedi kérésazonosító, nyomon követéshez hasznos.
failureReasons tömb Hibák listája (ha vannak), mindegyik tartalmaz kódot és paramétereket.
isSuccess logikai Jelzi, hogy a kérés sikeresen feldolgozásra került-e (true vagy false).

Hibaválaszok

HTTP kód Leírás
400 Hiányzó, érvénytelen vagy hibás formátumú paraméterek.
401 Nincs hitelesítve a felhasználó vagy nincs jogosultsága.
429 A felhasználó túllépte a rate limit-et.

Adatküldési munkamenet indítása

Általános leírás

A start-transports végpont lehetővé teszi egy vagy több már létrehozott fuvar indítását (aktiválását). Ez a művelet beállítja a fuvar kezdő dátumát, és aktívként jelöli a rendszerben.

A Rate Limit korlátozásai érvényesek.

⚠️ 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/eTransport/start-transports?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 a következő paramétereket kell tartalmazniuk:

  • Query paraméter:

    • api-version (string, kötelező) – Az API verziója. Ajánlott érték: 2.0

  • Body (JSON):

{
  "transports": [
    {
      "codeUit": "string"
    }
  ]
}
Paraméter Típus Kötelező Leírás
transports array Igen Az indítandó fuvarok listája.
codeUit string Igen A fuvar egyedi UIT azonosító kódja.

🕒 Fontos: Minden dátumot (startDate) UTC formátumban kell megadni.

Válasz szerkezete

{
  "payload": {
    "codeUit": "string",
    "isSuccess": true,
    "errors": [
      "string"
    ]
  },
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

Tulajdonság Típus Leírás
payload boolean Az indítás eredménye (true, ha sikeres volt).
correlationId string Egyedi kérésazonosító, nyomon követéshez hasznos.
failureReasons array Hibák listája (ha vannak), mindegyik tartalmaz kódot és paramétereket.
isSuccess boolean Jelzi, hogy a kérés sikeresen feldolgozásra került-e (true vagy false).

Hibaválaszok

HTTP kód Leírás
400 Hiányzó, érvénytelen vagy hibás formátumú paraméterek.
401 Nem hitelesített vagy jogosulatlan felhasználó.
429 A felhasználó túllépte a rate limit-et.

Adatküldési szakasz leállítása

Általános leírás

Az end-transports végpont lehetővé teszi egy vagy több aktív fuvarok leállítását UIT kód alapján. Ezzel a művelettel a fuvarok lezárásra kerülnek a rendszerben, és később már nem módosíthatók.

A Rate Limit korlátozásai érvényesek.

⚠️ Minden kéréshez kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/eTransport/end-transports?api-version=2.0

Kérés paraméterei

A végponthoz POST típusú kérést kell küldeni az alábbi paraméterekkel:

  • Query paraméter:

    • api-version (string, kötelező) – Az API verziója. Ajánlott érték: 2.0

  • Body (JSON):

{
  "transports": [
    {
      "codeUit": "string"
    }
  ]
}
Paraméter Típus Kötelező Leírás
transports array Igen A leállítandó fuvarok listája.
codeUit string Igen A fuvar egyedi UIT azonosítója.

🕒 Fontos: Minden dátum (endDate) UTC formátumban legyen megadva.

Válasz szerkezete

{
  "payload": {
    "codeUit": "string",
    "isSuccess": true,
    "errors": [
      "string"
    ]
  },
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

Tulajdonság Típus Leírás
payload boolean A leállítás eredménye (true, ha sikeres volt).
correlationId string Egyedi azonosító a kéréshez, nyomon követéshez.
failureReasons array Hibák listája (ha vannak), mindegyik tartalmaz kódot és paramétereket.
isSuccess boolean Jelzi, hogy a kérés sikeresen feldolgozásra került-e (true vagy false).

Hibaválaszok

HTTP kód Leírás
400 Hiányzó, érvénytelen vagy hibás formátumú paraméterek.
401 Nincs hitelesítés vagy jogosultság.
429 Felhasználó túllépte a rate limit-et.

Adatküldési szüneteltetés

Általános leírás

A pause-transports végpont lehetővé teszi egy aktív fuvar pozíciójának továbbításának szüneteltetését UIT kód alapján. Hasonlóan a start és stop végpontokhoz, a fuvarok ideiglenesen szüneteltethetők.

A Rate Limit korlátozásai érvényesek.

⚠️ Minden kéréshez kötelező az api-version=2.0 paramétert megadni az URL-ben.
URL: POST https://api.trackgps.ro/api/eTransport/pause-transports?api-version=2.0

Kérelem paraméterei

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

  • Query paraméter:

    • api-version (string, kötelező) – Az API verziója. Ajánlott érték: 2.0

  • Törzs (JSON):

{
  "transports": [
    {
      "codeUit": "string"
    }
  ]
}
Paraméter Típus Kötelező Leírás
transports tömb Igen A szüneteltetendő fuvarok listája.
codeUit string Igen A fuvar egyedi UIT azonosító kódja.

Válasz szerkezete

{
  "payload": true,
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "failureReasons": [
    {
      "errorCode": "string",
      "errorParameters": [
        "string"
      ]
    }
  ],
  "isSuccess": true
}

Tulajdonságok leírása

Tulajdonság Típus Leírás
payload boolean A szüneteltetés művelet eredménye (true, ha sikeres volt).
correlationId string Egyedi azonosító a kéréshez, nyomon követéshez hasznos.
failureReasons tömb Hibák listája (ha vannak), mindegyik kóddal és paraméterekkel.
isSuccess boolean Jelzi, hogy a kérés sikeresen feldolgozásra került-e (true vagy false).

Hibaválaszok

HTTP kód Leírás
400 Hiányzó, érvénytelen vagy hibás formátumú paraméterek.
401 Nem hitelesített vagy jogosulatlan felhasználó.
429 A felhasználó túllépte a rate limit-et.