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