FAQ: Mga Paraan ng Partner API

5.7.2024 | Veranika Patachyts

Ano ang Partner API?


Ang GPS-Trace Partner API ay isang makapangyarihang kasangkapan na nagbibigay-daan sa mga negosyo na isama ang mga advanced na kakayahan sa pagsubaybay ng GPS sa kanilang umiiral na mga sistema. Nag-aalok ito ng iba't ibang mga paraan para sa paglikha at pamamahala ng mga user account at mga plano ng kliyente, at mga unit ng configuration, at pagbuo ng mga custom na ulat at kahit na pag-download ng mga istatistika.


Paano ko i-authenticate ang aking mga kahilingan sa Partner API?


Gumagamit ang Partner API ng API token authentication upang matiyak ang secure na access. Kailangan mong bumuo ng isang API token mula sa iyong account, na gagamitin mo upang i-authenticate ang lahat ng iyong mga kahilingan.


Ano ang mga pangunahing tampok ng Partner API?


Ang mga pangunahing tampok ng GPS-Trace API ay kinabibilangan ng:

  • Pamamahala ng account
  • Pamamahala ng kumpanya
  • Pamamahala ng mga plano ng kliyente
  • Pamamahala ng mga unit
  • Pamamahala ng user
  • Pamamahala ng billing

Partner platform


Paano ko pamamahalaan ang mga user gamit ang Partner API?


Nagbibigay ang Partner API ng mga endpoint para sa pagpaparehistro at pamamahala ng user. Maaari kang lumikha ng mga bagong user account, i-update ang impormasyon ng user, at pamahalaan ang mga plano ng kliyente at mga set ng mga module at mga pahintulot upang matiyak ang isang secure at organisadong base ng user.


Paano gumagana ang pamamahala ng account?


Saklaw ng account CRUD subsection ang mga paraan na may kaugnayan sa CRUD (Create, Read, Update, Delete) na mga operasyon para sa mga account, na kinabibilangan ng:

  • Paglikha ng mga account: Mga paraan upang lumikha ng mga bagong account sa sistema.
  • Pag-delete ng mga account: Mga paraan upang alisin ang mga account mula sa sistema.
  • Pag-update ng mga account: Mga paraan upang i-update ang umiiral na impormasyon ng account.
  • Pagkuha ng impormasyon ng account: Mga paraan upang kunin ang mga detalye ng mga partikular na account.

Kapag lumilikha ng isang client account, isang application ang itatalaga sa account, na nagbibigay sa kliyente ng access. Ito ay ipinatutupad sa pamamagitan ng isang kahilingan, na may isa sa mga mandatoryong field na "reg_apps". Ang mga ID ng mga application ay kinabibilangan ng:

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

Ang mga entity ng user ay nilikha kasabay ng paglikha ng isang client account at sa simula ay hindi aktibo. 

Upang i-activate ang account:

  • ang partner ay nagpapadala ng isang espesyal na activation link sa kanilang kliyente.
  • Sa pag-click sa activation link, ipinasok ng kliyente ang kanyang natatanging email address (na maiuugnay sa account) at isang password.
  • Pagkatapos ay makakatanggap ang kliyente ng isang email ng kumpirmasyon ng pagpaparehistro sa ibinigay na address. Sa pamamagitan ng pagsunod sa link sa email, kumpletuhin ng kliyente ang proseso ng pagpaparehistro sa pamamagitan ng pagpasok ng hinihiling na impormasyon sa form, na maaaring kabilang ang password, login key, atbp.

Bilang resulta, lumikha ka ng isang bagong user sa tulong ng aming API sa ilang mga pag-click lamang.


Isa ba itong Partner API o isang API para sa GPS monitoring?


Ito ay tiyak na isang partner API batay sa functionality ng aming Partner Panel. Hindi mo maaaring subaybayan ang iyong fleet sa pamamagitan nito. Ang pangunahing layunin ay ang paghawak at pag-customize ng mga account ng kliyente at mga unit, pagtatatag ng mga taripa, pamamahala ng analytics, at kasaysayan. Gamit ang aming API, maaari mong isama ang aming partner platform sa iyong CRM at billing system.

GPS Partner API Documentation


Paano ito makikinabang sa aking negosyo?


Pinapasimple ng Partner API ang iba't ibang aspeto ng operasyon, tulad ng pamamahala ng sasakyan, pagsubaybay ng asset, at pag-uulat ng data. Sa pamamagitan ng pag-automate ng mga prosesong ito, maaaring mabawasan ng mga negosyo ang manu-manong pagsisikap at madagdagan ang kita nang madali.


Maaari ko bang ma-access ang historical tracking data gamit ang Partner API?


Oo, pinapayagan ng GPS-Trace Partner API ang pag-access sa historical tracking data.
Ang data na ito ay mahalaga para sa pagsusuri ng pagganap, pagsisiyasat ng mga insidente, at pag-optimize ng mga hinaharap na operasyon. Halimbawa, maaari mong gamitin ang GET /partner/units/{id}/messages(Get Unit Messages) na paraan upang makuha ang mga mensahe mula sa isang device (unit) sa Forguard. Ang maximum na bilang ng mga mensahe na maaaring makuha ay 10,000, at maaari mo ring tukuyin ang bilang ng mga kamakailang mensahe na nais mong makuha.

Halimbawa ng kahilingan upang makuha ang huling 10 mensahe:

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

Ang mga field sa tugon ay depende sa mga parameter na ipinadala ng tracker.


Paano makakatulong ang custom reporting sa aking negosyo?


Ang custom reporting ay nagbibigay-daan sa iyo upang bumuo ng mga detalyadong ulat batay sa iyong mga partikular na pangangailangan.
Ang mga ulat na ito ay maaaring maglaman ng data sa paggamit at kahusayan ng sasakyan, na nagbibigay ng mahalagang mga insight para sa paggawa ng desisyon at pagpapabuti ng mga estratehiya sa negosyo. Halimbawa, upang makuha ang pinakabagong telemetry data ng unit, dapat mong gamitin ang GET /partner/units/{id}/telemetry” (Get Telemetry Data) na paraan.

Halimbawa ng kahilingan:

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

Bilang resulta, magda-download ka ng ulat na may pinakabagong telemetry message ng bawat device na iyong tinukoy.


Paano ako makakapagsimula sa Partner API?


Upang makapagsimula sa Partner API, maaari mong punan ang form sa aming website o sumulat sa amin sa business@gps-trace.com