{"id":4542,"date":"2017-04-21T08:34:44","date_gmt":"2017-04-21T08:34:44","guid":{"rendered":"http:\/\/www.fmsdocumentation.com\/status-api\/"},"modified":"2018-06-04T11:12:26","modified_gmt":"2018-06-04T11:12:26","slug":"status-api","status":"publish","type":"page","link":"https:\/\/www.fmsdocumentation.com\/pl\/apis\/status-api\/","title":{"rendered":"API wsp\u00f3\u0142rz\u0119p\u00f3\u0142rz\u0119dnych obiektu w czasie rzeczywistym"},"content":{"rendered":"

Interfejsy API wsp\u00f3\u0142rz\u0119dnych obiektu w czasie rzeczywistym (Object Coordinates Streaming API) w g\u0142\u00f3wnej mierze s\u0142u\u017c\u0105 do informowania u\u017cytkownika o zmianach dotycz\u0105cych obiektu. Ten interfejs API zapewnia strumieniowe przesy\u0142anie informacji. Po wys\u0142aniu przez u\u017cytkownika \u017c\u0105dania API najpierw wy\u015bwietlana jest ostatnia znana wsp\u00f3\u0142rz\u0119dna ka\u017cdego z obiekt\u00f3w, a nast\u0119pnie nowe dane s\u0105 wysy\u0142ane do u\u017cytkownika bezpo\u015brednio po wyst\u0105pieniu jakiejkolwiek zmiany.\u00a0 Wysy\u0142anie kolejnych \u017c\u0105da\u0144 API nie jest konieczne, chyba \u017ce po\u0142\u0105czenie strumieniowe zosta\u0142o zerwane.\"\"<\/a><\/p>\n

Uwaga
\nPoniewa\u017c API najpierw zwraca ostatni\u0105 znan\u0105 wsp\u00f3\u0142rz\u0119dn\u0105, w przypadkach, gdy po\u0142\u0105czenie ze strumieniem API zosta\u0142o zerwane i nawi\u0105zane ponownie bez nowych wsp\u00f3\u0142rz\u0119dnych odebranych w tym czasie, u\u017cytkownik otrzyma ostatni\u0105 znan\u0105 wsp\u00f3\u0142rz\u0119dn\u0105, kt\u00f3ra zosta\u0142a ju\u017c raz odebrana raz, a wi\u0119c duplikat rekordu. Nale\u017cy o tym pami\u0119ta\u0107, poniewa\u017c w niekt\u00f3rych systemach mo\u017ce to powodowa\u0107 komplikacje.<\/p><\/p>\n

Przesy\u0142anie strumieniowe API wsp\u00f3\u0142rz\u0119dnych obiektu w czasie rzeczywistym mo\u017ce zosta\u0107 zainicjowane dla okre\u015blonego obiektu albo dla wszystkich obiekt\u00f3w dost\u0119pnych dla u\u017cytkownika.<\/p>\n

Przyk\u0142ad \u017c\u0105dania dla wskazanego obiektu:<\/p>\n

 <\/p>\n

GET \/object-coordinates-stream?version=1&object_id=<…>&api_key=<…>
\nHOST:api.fm-track.com
\nContent-Type:text\/event-stream;charset=UTF-8<\/p>\n

Przyk\u0142ad \u017c\u0105dania API dla wszystkich obiekt\u00f3w klient\u00f3w:<\/p>\n

GET \/object-coordinates-stream?version=1&api_key=<…>
\nHOST:api.fm-track.com
\nContent-Type:text\/event-stream;charset=UTF-8<\/p>\n

Ten interfejs API wymaga do dzia\u0142ania jedynie dw\u00f3ch parametr\u00f3w obowi\u0105zkowych:<\/p>\n\n\n\n\n\t\n\n\t\n\t
Parameter<\/th>Type<\/th>Description<\/th>\n<\/tr>\n<\/thead>\n
version<\/td>String<\/td>Version of the API, currently only version=1 is available<\/td>\n<\/tr>\n
api_key<\/td>User identification key<\/td><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

W \u017c\u0105daniu mo\u017cna umie\u015bci\u0107 jedynie jeden parametr opcjonalny:<\/p>\n\n\n\n\n\t\n\n\t
Parameter<\/th>Type<\/th>Description<\/th>\n<\/tr>\n<\/thead>\n
object_id<\/td>String<\/td>External object ID<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Odpowied\u017a z serwera:<\/p>\n

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<\/div><\/td>
data:<\/span>{<\/span>
\n"object_id"<\/span> :<\/span> "abc123"<\/span>,<\/span>
\n"datetime"<\/span> :<\/span> "2017-04-13T06:58:48.090Z"<\/span>,<\/span>
\n"ignition_status"<\/span> :<\/span> "UNKNOWN"<\/span>,<\/span>
\n"position"<\/span> :<\/span> {<\/span>
\n"altitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"direction"<\/span> :<\/span> 0<\/span>,<\/span>
\n"latitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"longitude"<\/span> :<\/span> 0<\/span>,<\/span>
\n"satellites_count"<\/span> :<\/span> 0<\/span>,<\/span>
\n"speed"<\/span> :<\/span> 0<\/span>
\n}<\/span>,<\/span>
\n"device_inputs"<\/span> :<\/span> {<\/span>
\n"digital_input_1"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_2"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_3"<\/span> :<\/span> true<\/span>,<\/span>
\n"digital_input_4"<\/span> :<\/span> true<\/span>,<\/span>
\n"power_supply_voltage"<\/span> :<\/span> 0<\/span>,<\/span>
\n"ibutton"<\/span> :<\/span> "xxxxxxxxxx"<\/span>,<\/span>
\n"first_driver_id"<\/span> :<\/span> "xxxxxxxxxx"<\/span>,<\/span>
\n"second_driver_id"<\/span> :<\/span> "xxxxxxxxxx"<\/span>
\n}<\/span>,<\/span>
\n"calculated_inputs"<\/span>:<\/span>{<\/span>
\n"mileage"<\/span> :<\/span> 0<\/span>
\n}<\/span>
\n}<\/span><\/div><\/td><\/tr><\/tbody><\/table><\/div>\n

Poni\u017csza tabela przedstawia wszystkie pola odpowiedzi, kt\u00f3re mog\u0119 by\u0107 otrzymane dla ka\u017cdego rodzaju parametru:<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t
Name<\/th>Type<\/th>Description<\/th>Units<\/th>\n<\/tr>\n<\/thead>\n
object_id<\/td>String<\/td>Object identifier in our system<\/td>Text<\/td>\n<\/tr>\n
device_inputs<\/td>Container for parameters received from hardware<\/td><\/td><\/td>\n<\/tr>\n
calculated_inputs<\/td>Container for parameters calculated in system from other parameters according configuration<\/td><\/td><\/td>\n<\/tr>\n
datetime<\/td>Date<\/td>Date and time point of coordinate generated in hardware
\nFormat: \"yyyy-mm-ddThh:mm:ss.sssZ\"
\n<\/td>		According ISO8601<\/td>\n<\/tr>\n
longitude<\/td>Float<\/td>GPS coordinate - longitude value<\/td>Degrees<\/td>\n<\/tr>\n
latitude<\/td>Float<\/td>GPS coordinate - latitude value<\/td>Degrees<\/td>\n<\/tr>\n
altitude<\/td>Integer<\/td>GPS coordinate - altitude value<\/td>Number<\/td>\n<\/tr>\n
speed<\/td>Integer<\/td>Object moving speed<\/td>km\/h<\/td>\n<\/tr>\n
direction<\/td>Integer<\/td>Moving direction in degrees<\/td>0 = north, increasing clock-wise<\/td>\n<\/tr>\n
ignition_status<\/td>Enum<\/td>Indicating if object has ignition on.
\n\"ON\" - Ignition on
\n\"OFF\" - Ignition off
\n\"UNKNOWN\" - No data about ignition
\n<\/td>		ON - OFF<\/td>\n<\/tr>\n
digital_input_1<\/td>Boolean<\/td>Configured object or its equipment status
\ntrue - status = active
\nfalse - status = inactive
\n<\/td>		True - False<\/td>\n<\/tr>\n
digital_input_2<\/td>Boolean<\/td>Configured object or its equipment status
\ntrue - status = active
\nfalse - status = inactive
\n<\/td>		True - False<\/td>\n<\/tr>\n
digital_input_3<\/td>Boolean<\/td>Configured object or its equipment status
\ntrue - status = active
\nfalse - status = inactive
\n<\/td>		True - False<\/td>\n<\/tr>\n
digital_input_4<\/td>Boolean<\/td>Configured object or its equipment status
\ntrue - status = active
\nfalse - status = inactive
\n<\/td>		True - False<\/td>\n<\/tr>\n
ibutton<\/td>String<\/td>iButton or RFID card code of a driver assigned to a vehicle<\/td>Text<\/td>\n<\/tr>\n
first_driver_id<\/td>String<\/td>TCO code of the first driver<\/td>Text<\/td>\n<\/tr>\n
second_driver_id<\/td>String<\/td>TCO code of the second driver<\/td>Text<\/td>\n<\/tr>\n
satellites_count<\/td>Integer<\/td>Number of visible GPS or GLONASS satellites(depends on device configuration) while generating record in device<\/td>Number<\/td>\n<\/tr>\n
mileage<\/td>float<\/td>Object driven distance (depends on object configuration)<\/td>km<\/td>\n<\/tr>\n
power_supply_voltage<\/td>Integer<\/td>Object power supply voltage<\/td>mV<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Punkty ko\u0144cowe interfejsu API, parametry \u017c\u0105dania i komunikaty zwrotne mo\u017cna przegl\u0105da\u0107 przy pomocy edytora \u201eSwagger\u201d za po\u015brednictwem: https:\/\/api.fm-track.com<\/a><\/p>\n

Uwaga
\nNale\u017cy pami\u0119ta\u0107, \u017ce odpowied\u017a z serwera jest strumieniem danych, tych samych, kt\u00f3re s\u0105 odbierane z urz\u0105dzenia. Wszystkie otrzymane dane s\u0105 dostarczane \u201etak jak jest\u201d. Oznacza to, \u017ce urz\u0105dzenie mo\u017ce czasem mi\u0119dzy rekordami pozycji aktualnej wysy\u0142a\u0107 wsp\u00f3\u0142rz\u0119dne pozycji poprzedniej. Interfejs API nie sprawdza ani nie reguluje ci\u0105g\u0142o\u015bci odebranych danych.<\/p><\/p>\n

\n

\u2039   <\/span> API historycznych wsp\u00f3\u0142p\u00f3\u0142rz\u0119z\u0119ddnych obiektu <\/a><\/div>
API obiektu  \u203a <\/span> <\/a><\/div><\/p>\n","protected":false},"excerpt":{"rendered":"

Interfejsy API wsp\u00f3\u0142rz\u0119dnych obiektu w czasie rzeczywistym (Object Coordinates Streaming API) w g\u0142\u00f3wnej mierze s\u0142u\u017c\u0105 do informowania u\u017cytkownika o zmianach dotycz\u0105cych obiektu. Ten interfejs API zapewnia strumieniowe przesy\u0142anie informacji. Po wys\u0142aniu przez u\u017cytkownika \u017c\u0105dania API najpierw wy\u015bwietlana jest ostatnia znana wsp\u00f3\u0142rz\u0119dna ka\u017cdego z obiekt\u00f3w, a nast\u0119pnie nowe dane s\u0105 wysy\u0142ane do u\u017cytkownika bezpo\u015brednio po wyst\u0105pieniu … Czytaj dalej API wsp\u00f3\u0142rz\u0119p\u00f3\u0142rz\u0119dnych obiektu w czasie rzeczywistym<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":4544,"menu_order":3,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-4542","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages\/4542","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/comments?post=4542"}],"version-history":[{"count":2,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages\/4542\/revisions"}],"predecessor-version":[{"id":5214,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages\/4542\/revisions\/5214"}],"up":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/pages\/4544"}],"wp:attachment":[{"href":"https:\/\/www.fmsdocumentation.com\/pl\/wp-json\/wp\/v2\/media?parent=4542"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}