Об’єктний API

Основна мета об’єктних API – надати базову інформацію про один або всі об’єкти клієнта. Об’єктний API може запитувати або один конкретний об’єкт, або, якщо не вказано жодного об’єкта, API поверне всі існуючі об’єкти клієнта.

Приклад запиту API для конкретного об’єкта:

GET /objects/{object_id}?version=1&api_key=<...>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8

Для роботи цього API обов’язковими є два параметри (не враховуючи API_key):

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

Якщо параметр було введено неправильно, система відповість кодом помилки. Всі коди помилок описані в розділі API. Параметри, для яких не надано жодних даних, не включаються у відповідь. Повний список параметрів відповіді доступний в кінці цього розділу.

Приклад запиту API для всіх об’єктів клієнтів:

GET /objects?version=1&api_key=<...>
HOST: api.fm-track.com
Content-Type:application/json;charset=UTF-8

Для роботи цього API обов’язковим є лише один параметр (не враховуючи API_key):

Відповідь від сервера ідентична відповіді для одного об’єкта, за винятком того, що список продовжується для кожного з об’єктів клієнта.

Всі поля відповіді, які можна отримати з кожним типом параметра, описані в наступній таблиці:

Кінцеві точки API, параметри запитів та відповіді можна переглянути в “Swagger” за цим посиланням: https: //api.fm-track.com.