Objekto API sąsajos pagrindinis tikslas yra pateikti pagrindinę informaciją apie vieną ar kelis klientų objektus. Objektų API galima gauti vienam konkrečiam objektui arba, jei objektai nėra nurodyti, API pateiks visus esančius kliento objektus.
API užklausos pavyzdys konkrečiam objektui:
GET /objects/{object_id}?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Kad ši API užklausa veiktų, privalomi du parametrai (neskaičiuojant API rakto):
| Parametras | Tipas | Aprašymas |
|---|---|---|
| objectId | Tekstas | Objekto identifikatorius (Šį ID galima gauti siunčiant API užklausą visiems galimiems kliento objektams) |
| version | Tekstas | API versija, šiuo metu galima tik version=1 |
| api_key | Tekstas | Vartotojo identifikacinis raktas |
{
"id": "abc123",
"name": "AAA 000",
"imei": "123456789123",
"vehicle_params": {
"vin": null,
"make": null,
"model": null,
"plate_number": null
}
}
API užklausos pavyzdys visiems klientų objektams:
GET /objects?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Kad ši API užklausa veiktų, privalomas vienas parametras (neskaičiuojant API rakto);
| Parametras | Tipas | Aprašymas |
|---|---|---|
| version | Tekstas | API versija, šiuo metu galima tik version=1 |
| api_key | Tekstas | Vartotojo identifikacinis raktas |
Serverio atsakymas yra identiškas atsakymui, kai pasirenkamas vienas objektas, tačiau sąraše pateikiami visi klientų objektai.
Visi atsakymų laukeliai , kuriuos galima gauti su kiekvienu parametro tipu, aprašyti sekančioje lentelėje:
| Parametras | Tipas | Aprašymas |
|---|---|---|
| name | Tekstas | Transporto priemonės pavadinimas |
| imei | Tekstas | Transporto priemonės IMEI kodas |
| make | Tekstas | Transporto priemonės markė |
| model | Tekstas | Transporto priemonės modelis |
| object_id | Tekstas | Objekto identifikatorius (išorinis) |
| vin | Tekstas | Objekto VIN numeris |
| plate_number | Tekstas | Objekto valstybinis numeris |
API rezultatus, užklausų parametrus ir atsakymus galima peržiūrėti „Swagger“ programoje, naudojantis šia nuoroda: https://api.fm-track.com