API objekata

Glavna svrha objektnih API-ja je pružanje osnovnih informacija o jednom ili svim objektima klijenta. Objektni API može zatražiti ili jedan određeni objekt ili, ako nijedan objekt nije naveden, API će vratiti sve postojeće objekte klijenta.

Primjer API zahtjeva za određeni objekt:

GET /objekti/{object_id} ?verzija=1&api_key= <...>
DOMAĆIN: api.fm-track.com
Vrsta sadržaja: aplikacija/json; skup znakova=UTF-8

Da bi ovaj API radio, obavezna su dva parametra (ne računajući API_key):

{
            "id": "abc123",
            "name": "AAA 000",
            "imei": "123456789123",
            "vehicle_params": {
                "vin": null,
                "make": null,
                "model": null,
              	"plate_number": null
            }
}

Ako je parametar netočno unesen, sustav će odgovoriti kodom pogreške. Svi kodovi pogrešaka opisani su u odjeljku API-ji . Parametri za koje nisu navedeni podaci nisu uključeni u odgovor. Potpuni popis parametara odgovora dostupan je na kraju ovog odjeljka.

Primjer API zahtjeva za sve klijentske objekte:

GET /objekti?verzija=1&api_key= <...>
DOMAĆIN: api.fm-track.com
Vrsta sadržaja: aplikacija/json; skup znakova=UTF-8

Da bi ovaj API radio, obavezan je samo jedan parametar (ne računajući API_key):

Odgovor poslužitelja identičan je odgovoru za jedan objekt, osim što se popis nastavlja za svaki od klijentskih objekata.

Sva polja odgovora koja se mogu primiti sa svakom vrstom parametra opisana su u sljedećoj tablici:

API krajnje točke, parametri zahtjeva i odgovori mogu se pregledati u „Swaggeru” putem ove poveznice: https://api.fm-track.com