El propósito principal de la API de objeto es proporcionar información básica sobre un objeto o todos los objetos del usuario. La API de objeto puede ser solicitada para un objeto o si no se especifica ningún objeto, la API devolverá todos los objetos existentes del usuario.
Ejemplo de solicitud para un objeto específico:
GET /objects/{object_id}?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Dos parámetros son obligatorios para que funcione esta API (sin contar el API_key):
| Parámetro | Tipo | Descripción |
|---|---|---|
| objectId | Cadena | Identificador del objeto (se puede obtener este ID enviando una solicitud de API para todos los objetos disponibles del usuario) |
| version | Cadena | Versión de la API, actualmente solo version=1 está disponible |
| api_key | Cadena | Clave de identificación del usuario |
{
"id": "abc123",
"name": "AAA 000",
"imei": "123456789123",
"vehicle_params": {
"vin": null,
"make": null,
"model": null,
}
}Ejemplo de solicitud para todos los objetos del usuario:
GET /objects?version=1&api_key=<…>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8
Un parámetro es obligatorio para que funcione esta API (sin contar el API_key):
| Parámetro | Tipo | Descripción |
|---|---|---|
| version | Cadena | Versión de la API, actualmente solo version=1 está disponible |
| api_key | Cadena | Clave de identificación del usuario |
La respuesta del servidor es idéntica a la respuesta para un objeto, la lista simplemente continua para cada objeto del usuario.
Todos los parámetros de respuesta que se puede recibir:
| Parámetro | Tipo | Descripción |
|---|---|---|
| name | Cadena | Nombre del objeto |
| imei | Cadena | Código IMEI del objeto |
| make | Cadena | Marca del objeto |
| model | Cadena | Modelo del objeto |
| object_id | Cadena | Identificador del objeto (externo) |
| vin | Cadena | Número de chasis (VIN) del objeto |
Se puede ver los puntos finales de API, los parámetros de solicitudes y las respuestas en “Swagger” haciendo clic en este enlace: https://api.fm-track.com