Pagrindinis Vairuotojų API tikslas yra pateikti informaciją apie vairuotoją. Šis API turi dviejų tipų užklausas – vieną konkrečiam vairuotojui ir kitą visiems vairuotojams.
Konkretaus vairuotojo užklausos pavyzdys:
GET /drivers/{driverId}?version=1&api_key=<…>
HOST:api.fm-track.com
Content-Type:application/json;charset=UTF-8
Šis parametras yra pasirinktinas. Jei jis įtraukiamas į užklausą, bus pateikiami vieno konkretaus vairuotojo duomenys. Jei parametras praleidžiamas, bus pateikiami visų vairuotojų duomenys.
| Parametras | Tipas | Aprašymas |
|---|---|---|
| driverId | Tekstas | Vairuotojo identifikatorius |
Kad šis API veiktų, privaloma pateikti šiuos parametrus:
| Parametras | Tipas | Aprašymas |
|---|---|---|
| version | Tekstas | API versija, šiuo metu galima tik version=1 |
| api_key | Tekstas | Vartotojo identifikacinis raktas |
Serverio atsako pavyzdys:
{
"id": "string",
"first_name": "string",
"last_name": "string"
}
Visi atsakymų, kuriuos galima gauti su kiekvienu parametro tipu, laukeliai aprašyti sekančioje lentelėje:
| Parametras | Tipas | Aprašymas | Matavimo vienetai |
|---|---|---|---|
| id | Tekstas | Vairuotojo identifikatorius | Tekstas |
| first_name | Tekstas | Vairuotojo vardas | Tekstas |
| last_name | Tekstas | Vairuotojo pavardė | Tekstas |
API rezultatus, užklausų parametrus ir atsakymus galima peržiūrėti „Swagger“ programoje, naudojantis šia nuoroda: https://api.fm-track.com