Apie API:
API (taikomosios programos sąsaja) leidžia klientams integruoti FMS su jų sistemomis, gauti ir siųsti duomenis apie įvairius objektus. Klientas siunčia HTTP užklausas sistemai, pateikdamas informaciją apie norimą veiksmą.
Jei klientas klausia apie integraciją su savo ar partnerių sistemomis, galite pasiūlyti esamą API funkcionalumą. Pagrindinis API dokumentacijos šaltinis (galima dalintis su klientais): https://www.fmsdocumentation.com/apis/
Kaip sukurti API raktą?
A. Visam parkui:
1. Norėdami sukurti API raktą visiems parko objektams (visiems paskyros objektams), prisijunkite prie „TrustTrack” (administratoriaus) paskyros, kuri prašo API integracijos;
2. Viršutiniame dešiniajame kampe spustelėkite „Paskyros nustatymai“:
3. Pasirinkite API rakto nustatymus ir sukurkite naują API raktą:
4. Nustatykite API rakto pavadinimą ir nukopijuokite jį, tada perduokite savo klientui/partneriui tolimesniam naudojimui pagal bendrinamą dokumentaciją.
PASTABA: Jeigu trečioji šalis (partneris ar kt.) prašo API rakto esamam mūsų klientui, jie privalo pateikti pasirašytą susitarimą su klientu. Priešingu atveju API raktas negali būti suteiktas.
B. Pasirinktiems objektams:
Kartais API raktas reikalingas tik kelioms transporto priemonėms. Tokiu atveju reikia atlikti kelis papildomus žingsnius:
1. Sukurkite naują žiniatinklio naudotoją kliento vardu. Šis žiniatinklio naudotojas turėtų būti sukurtas ir naudojamas tik vidiniam (API) naudojimui. PASTABA: vartotojo tipas turi būti vartotojas (user), o ne administratorius (admin). Patikrinkite ar vartotojas jau nebuvo sukurtas tuo pačiu vardu, ar el. paštu;
2. Prisijunkite kaip Administratorius ir sukurkite naują transporto priemonių grupę;
3. Pridėkite reikalingas transporto priemones į sukurtą grupę;
4. Priskirkite sukurtą grupę API žiniatinklio naudotojui ir įgalinkite API prieigą:
Prisijunkite naudodami vartotoją, kuris buvo sukurtas 1-ajame žingsnyje.
Sukurkite API raktą po vartotoju ir pasidalinkite juo su klientu.
Šiuo atveju objektų kiekį, kuris yra matomas vartotojui ir per API, reguliuoja objektų skaičius „TrustTrack“ grupėje (sukurtas 3-ajame žingsnyje).
Jeigu klientas prašo objekto ID API užklausoms, jį lengvai galite pateikti naudodami šią nuorodą: https://api.fm-track.com/objects?version=1&api_key=API_RAKTAS
Po ženklo „=“ reikia įterpti sukurtą API raktą ir paspausti „Enter“ savo naršyklės paieškos juostoje. Nukopijuokite ID iš atsakyme gauto rezultato. Arba atsiųskite klientui nuorodą su instrukcija, kaip gauti ID: https://www.fmsdocumentation.com/apis/object-api/
Pabaigoje pateikite klientui (partneriams):
API dokumentacija - https://www.fmsdocumentation.com/apis/;
API raktą (visiems objektams – A pasirinkimas arba ribotam kiekiui – B pasirinkimas).