Lo scopo principale delle Object API è quello di fornire informazioni di base su uno o tutti gli oggetti del cliente. Le API Object possono richiedere un oggetto specifico oppure, se non viene specificato alcun oggetto, le API restituiranno tutti gli oggetti esistenti del cliente.
Esempio di richiesta API per un oggetto specifico:
GET /objects/{object_id}?version=1&api_key=<...>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Affinché questa API funzioni, due parametri (senza contare la API_key) sono obbligatori:
| Parameter | Type | Description |
|---|---|---|
| objectId | String | Object identifier (This ID can be acquired by sending and API request for clients all available objects) |
| version | String | Version of the API, currently only version=1 is available |
| api_key | String | User identification key |
{
"id": "abc123",
"name": "AAA 000",
"imei": "123456789123",
"vehicle_params": {
"vin": null,
"make": null,
"model": null,
"plate_number": null
}
}Se un parametro è stato inserito in modo errato, il sistema risponderà con un codice di errore. Tutti i codici di errore sono descritti nella sezione API. I parametri per i quali non vengono forniti dati non sono inclusi nella risposta. L’elenco completo dei parametri di risposta è disponibile alla fine di questa sezione.
Esempio di richiesta API per tutti gli oggetti dei clienti:
GET /objects?version=1&api_key=<...>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Affinché questa API funzioni, è obbligatorio un solo parametro (senza contare l’API_key):
| Parameter | Type | Description |
|---|---|---|
| version | String | Version of the API, currently only version=1 is available |
| api_key | String | User identification key |
La risposta del server è identica alla risposta per un solo oggetto, ma l’elenco continua per tutti gli oggetti dei clienti.
Tutti i campi di risposta che possono essere ricevuti con ogni tipo di parametro sono descritti nella tabella successiva:
| Name | Type | Description |
|---|---|---|
| name | String | Visible vehicle name |
| imei | String | Vehicle hardware IMEI code |
| make | String | Vehicle brand |
| model | String | Vehicle brand model |
| object_id | String | Object identifier (external) |
| vin | String | VIN of object |
| plate_number | String | Plate number of object |
Gli endpoint API, i parametri di richiesta e le risposte possono essere visualizzati in anteprima in “Swagger” attraverso questo link: https: //api.fm-track.com