DUK: Partnerio API metodai

5.7.2024 | Veranika Patachyts

Kas yra Partnerio API?


GPS-Trace Partnerio API yra galingas įrankis, leidžiantis verslams integruoti pažangias GPS sekimo galimybes į savo esamas sistemas. Jis siūlo įvairius metodus vartotojų paskyrų ir klientų planų kūrimui ir valdymui, objektų konfigūravimui, individualių ataskaitų generavimui ir net statistikos atsisiuntimui.


Kaip autentifikuoti savo užklausas Partnerio API?


Partnerio API naudoja API žetonų autentifikavimą, siekiant užtikrinti saugų prieigą. Jums reikia sugeneruoti API žetoną iš savo paskyros, kurį naudosite visoms savo užklausoms autentifikuoti.


Kokios yra pagrindinės funkcijos Partnerio API?


GPS-Trace API pagrindinės funkcijos apima:

  • Paskyrų valdymas
  • Įmonės valdymas
  • Klientų planų valdymas
  • Objektų valdymas
  • Vartotojų valdymas
  • Atsiskaitymo valdymas

Partnerio platforma


Kaip galiu valdyti vartotojus su Partnerio API?


Partnerio API teikia galutinius taškus vartotojų registracijai ir valdymui. Galite kurti naujas vartotojų paskyras, atnaujinti vartotojų informaciją ir valdyti klientų planus bei modulių ir leidimų rinkinius, siekiant užtikrinti saugią ir organizuotą vartotojų bazę.


Kaip veikia paskyrų valdymas?


Paskyrų CRUD poskyris apima metodus, susijusius su CRUD (Sukurti, Skaityti, Atnaujinti, Ištrinti) operacijomis paskyroms, įskaitant:

  • Paskyrų kūrimas: metodai naujų paskyrų kūrimui sistemoje.
  • Paskyrų ištrynimas: metodai paskyrų pašalinimui iš sistemos.
  • Paskyrų atnaujinimas: metodai esamos paskyros informacijos atnaujinimui.
  • Paskyros informacijos gavimas: metodai specifinių paskyrų detalių gavimui.

Kuriant kliento paskyrą, paskyrai priskiriama programa, suteikianti klientui prieigą. Tai įgyvendinama per užklausą, kurioje vienas iš privalomų laukų yra "reg_apps". Programų ID apima:

  • Ruhavik - 5a5ca87f-7cbe-4540-ab5d-77bf4bf69884
  • Petovik - 962e19f0-6b4a-4f81-a3fe-4b657689b6f9
  • Forguard - b901da51-ce00-4af2-b978-8d0fca8ae1ea

Vartotojų vienetai sukuriami kartu su kliento paskyros sukūrimu ir iš pradžių yra neaktyvūs. 

Norėdami aktyvuoti paskyrą:

  • partneris siunčia specialią aktyvavimo nuorodą savo klientui.
  • Paspaudęs aktyvavimo nuorodą, klientas įveda savo unikalų el. pašto adresą (kuris bus susietas su paskyra) ir slaptažodį.
  • Klientas tada gauna registracijos patvirtinimo el. laišką nurodytu adresu. Sekdamas nuorodą el. laiške, klientas užbaigia registracijos procesą įvesdamas prašomą informaciją formoje, kuri gali apimti slaptažodį, prisijungimo raktą ir kt.

Rezultate, jūs sukuriate naują vartotoją naudodamiesi mūsų API vos keliais paspaudimais.


Ar tai Partnerio API ar API GPS stebėjimui?


Tai tikrai partnerio API, pagrįsta mūsų Partnerio Panelės funkcionalumu. Negalite stebėti savo parko per ją. Pagrindinis tikslas yra klientų paskyrų ir objektų tvarkymas ir pritaikymas, tarifų nustatymas, analizės ir istorijos valdymas. Naudodamiesi mūsų API, galite integruoti mūsų partnerio platformą su savo CRM ir atsiskaitymo sistema.

GPS Partnerio API dokumentacija


Kaip tai gali naudingai paveikti mano verslą?


Partnerio API supaprastina įvairius operacinius aspektus, tokius kaip transporto priemonių valdymas, turto sekimas ir duomenų ataskaitų teikimas. Automatizuodami šiuos procesus, verslai gali sumažinti rankinį darbą ir lengvai padidinti pelningumą.


Ar galiu naudotis istoriniais sekimo duomenimis naudodamasis Partnerio API?


Taip, GPS-Trace Partnerio API leidžia naudotis istoriniais sekimo duomenimis.
Šie duomenys yra vertingi analizuojant veiklą, tiriant incidentus ir optimizuojant būsimą veiklą. Pavyzdžiui, galite naudoti GET /partner/units/{id}/messages(Gauti objekto pranešimus) metodą, norėdami gauti pranešimus iš įrenginio (objekto) Forguard. Maksimalus pranešimų skaičius, kurį galima gauti, yra 10 000, taip pat galite nurodyti norimų gauti naujausių pranešimų skaičių.

Pavyzdinė užklausa gauti paskutinius 10 pranešimų:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/messages?count=10' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Atsakymo laukai priklausys nuo sekimo įrenginio siunčiamų parametrų.


Kaip individualios ataskaitos gali padėti mano verslui?


Individualios ataskaitos leidžia generuoti detalias ataskaitas pagal jūsų specifinius poreikius.
Šios ataskaitos gali apimti duomenis apie transporto priemonių naudojimą ir efektyvumą, teikiant vertingas įžvalgas sprendimų priėmimui ir verslo strategijų tobulinimui. Pavyzdžiui, norėdami gauti naujausius objekto telemetrijos duomenis, turėtumėte naudoti GET /partner/units/{id}/telemetry” (Gauti telemetrijos duomenis) metodą.

Pavyzdinė užklausa:

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/telemetry' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Rezultate, jūs atsisiųsite ataskaitą su naujausiu kiekvieno nurodyto įrenginio telemetrijos pranešimu.


Kaip pradėti naudotis Partnerio API?


Norėdami pradėti naudotis Partnerio API, galite užpildyti formą mūsų svetainėje arba parašyti mums adresu business@gps-trace.com