FAQ: Metode API Mitra | Blog | GPS-Trace

FAQ: Metode API Mitra

5.7.2024 | Veranika Patachyts

Apa itu API Mitra?


GPS-Trace Partner API adalah alat yang kuat yang memungkinkan bisnis untuk mengintegrasikan kemampuan pelacakan GPS lanjutan ke dalam sistem yang ada. Ini menawarkan berbagai metode untuk membuat dan mengelola akun pengguna dan rencana klien, dan unit konfigurasi, serta menghasilkan laporan khusus dan bahkan mengunduh statistik.


Bagaimana cara mengautentikasi permintaan saya ke API Mitra?


API Mitra menggunakan autentikasi token API untuk memastikan akses yang aman. Anda perlu menghasilkan token API dari akun Anda, yang kemudian akan Anda gunakan untuk mengautentikasi semua permintaan Anda.


Apa saja fitur utama dari API Mitra?


Fitur utama dari GPS-Trace API meliputi:

  • Manajemen akun
  • Manajemen perusahaan
  • Manajemen rencana klien
  • Manajemen unit
  • Manajemen pengguna
  • Manajemen penagihan

Platform Mitra


Bagaimana saya bisa mengelola pengguna dengan API Mitra?


API Mitra menyediakan endpoint untuk pendaftaran dan manajemen pengguna. Anda dapat membuat akun pengguna baru, memperbarui informasi pengguna, dan mengelola rencana klien serta set modul dan izin untuk memastikan basis pengguna yang aman dan terorganisir.


Bagaimana cara kerja manajemen akun?


Subbagian CRUD akun mencakup metode yang terkait dengan operasi CRUD (Create, Read, Update, Delete) untuk akun, yang meliputi:

  • Membuat akun: Metode untuk membuat akun baru dalam sistem.
  • Menghapus akun: Metode untuk menghapus akun dari sistem.
  • Memperbarui akun: Metode untuk memperbarui informasi akun yang ada.
  • Mengambil informasi akun: Metode untuk mengambil detail akun tertentu.

Saat membuat akun klien, aplikasi ditugaskan ke akun, memberikan akses kepada klien. Ini diimplementasikan melalui permintaan, dengan salah satu bidang wajib adalah "reg_apps". ID aplikasi meliputi:

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

Entitas pengguna dibuat bersamaan dengan pembuatan akun klien dan awalnya tidak aktif. 

Untuk mengaktifkan akun:

  • mitra mengirimkan tautan aktivasi khusus kepada klien mereka.
  • Setelah mengklik tautan aktivasi, klien memasukkan alamat email uniknya (untuk dikaitkan dengan akun) dan kata sandi.
  • Klien kemudian menerima email konfirmasi pendaftaran di alamat yang diberikan. Dengan mengikuti tautan dalam email, klien menyelesaikan proses pendaftaran dengan memasukkan informasi yang diminta dalam formulir, yang dapat mencakup kata sandi, kunci login, dll.

Hasilnya, Anda membuat pengguna baru dengan bantuan API kami hanya dalam beberapa klik.


Apakah ini API Mitra atau API untuk pemantauan GPS?


Ini jelas merupakan API mitra berdasarkan fungsionalitas Partner Panel kami. Anda tidak dapat memantau armada Anda melalui itu. Target utamanya adalah menangani dan menyesuaikan akun klien dan unit, menetapkan tarif, mengelola analitik, dan sejarah. Menggunakan API kami, Anda dapat mengintegrasikan platform mitra kami dengan sistem CRM dan penagihan Anda.

Dokumentasi API Mitra GPS


Bagaimana ini bisa menguntungkan bisnis saya?


API Mitra menyederhanakan berbagai aspek operasional, seperti manajemen kendaraan, pelacakan aset, dan pelaporan data. Dengan mengotomatisasi proses ini, bisnis dapat mengurangi upaya manual dan meningkatkan profitabilitas dengan mudah.


Bisakah saya mengakses data pelacakan historis menggunakan API Mitra?


Ya, GPS-Trace Partner API memungkinkan akses ke data pelacakan historis.
Data ini berharga untuk menganalisis kinerja, menyelidiki insiden, dan mengoptimalkan operasi di masa depan. Misalnya, Anda dapat menggunakan metode GET /partner/units/{id}/messages(Get Unit Messages) untuk mengambil pesan dari perangkat (unit) di Forguard. Jumlah maksimum pesan yang dapat diambil adalah 10.000, dan Anda juga dapat menentukan jumlah pesan terbaru yang ingin Anda peroleh.

Contoh permintaan untuk mendapatkan 10 pesan terakhir:

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

Bidang dalam respons akan bergantung pada parameter yang dikirim oleh pelacak.


Bagaimana pelaporan khusus dapat membantu bisnis saya?


Pelaporan khusus memungkinkan Anda untuk menghasilkan laporan terperinci berdasarkan kebutuhan spesifik Anda.
Laporan ini dapat mencakup data tentang penggunaan dan efisiensi kendaraan, memberikan wawasan berharga untuk pengambilan keputusan dan meningkatkan strategi bisnis. Misalnya, untuk mendapatkan data telemetri unit terbaru, Anda harus menggunakan metode GET /partner/units/{id}/telemetry” (Get Telemetry Data).

Contoh permintaan:

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

Hasilnya, Anda akan mengunduh laporan dengan pesan telemetri terbaru dari setiap perangkat yang Anda tentukan.


Bagaimana saya bisa memulai dengan API Mitra?


Untuk memulai dengan API Mitra, Anda dapat mengisi formulir di situs web kami atau menulis kepada kami di business@gps-trace.com