Apa itu GPS-Trace Platform API?
Platform API adalah antarmuka perangkat lunak untuk Pengguna GPS-Trace Console yang terdaftar. API ini memungkinkan sistem eksternal, seperti CRM, penagihan, atau alat pelaporan, untuk meminta data GPS-Trace dan menjalankan operasi Console tertentu.
API ini mencakup metode untuk bekerja dengan Pengguna, client plan, Unit, data penagihan, statistik, dan laporan.
Bagaimana cara melakukan autentikasi permintaan API?
Permintaan API diautentikasi menggunakan token API. Token adalah kunci akses yang dihasilkan di GPS-Trace Console. Token harus disertakan dalam setiap permintaan agar platform dapat memeriksa tindakan apa saja yang diizinkan untuk Pengguna.
Token dikirimkan di header permintaan X-AccessToken.
Grup metode API apa saja yang tersedia?
API ini mencakup grup metode berikut:
- Metode data Akun
- Metode data perusahaan
- Metode client plan
- Metode Unit
- Metode Pengguna
- Metode data penagihan
- Metode statistik dan laporan
Bagaimana saya dapat bekerja dengan Pengguna melalui API?
Platform API menyediakan metode untuk bekerja dengan Pengguna. Bergantung pada izin yang tersedia, Pengguna Console dapat membuat data Pengguna, memperbarui data Pengguna, serta menetapkan client plan, modul, dan izin.
Bagaimana cara kerja metode data Akun?
Bagian Akun mencakup metode untuk membuat, membaca, memperbarui, dan menghapus data Akun. Tindakan ini sering disebut sebagai operasi CRUD.
- Membuat Akun
- Menghapus Akun
- Memperbarui data Akun
- Mengambil data Akun
Saat Akun klien dibuat, permintaan dapat menyertakan aplikasi yang harus ditetapkan ke Akun tersebut. Ini dilakukan melalui kolom reg_apps. Aplikasi yang tersedia bergantung pada level akses Pengguna dan ketentuan perjanjian.
Data Pengguna dibuat bersamaan dengan Akun klien dan bersifat tidak aktif sampai proses aktivasi selesai.
Untuk mengaktifkan Akun:
- Pengguna Console mengirimkan tautan aktivasi kepada klien.
- Klien membuka tautan tersebut dan memasukkan alamat email serta kata sandi.
- Klien mengonfirmasi pendaftaran melalui tautan konfirmasi di email.
- Setelah dikonfirmasi, Akun Pengguna menjadi aktif sesuai aplikasi, plan, dan izin yang ditetapkan.
Apakah API ini digunakan untuk melacak kendaraan secara langsung?
API ini ditujukan untuk operasi GPS-Trace Console dan pertukaran data dengan sistem eksternal. API ini bukan pengganti aplikasi seluler Forguard atau antarmuka pelacakan GPS-Trace lainnya.
Pengguna Console dapat menggunakan API untuk bekerja dengan Unit, client plan, statistik, Riwayat, sistem CRM, dan sistem penagihan, bergantung pada level akses mereka.
API ini dapat digunakan untuk apa?
Platform API dapat digunakan untuk menghubungkan GPS-Trace dengan CRM, penagihan, pelaporan, atau sistem internal.
Misalnya, Pengguna Console dapat mengambil data Unit, bekerja dengan client plan, mengekspor statistik, serta mengurangi tindakan manual berulang dalam alur kerja eksternal.
Bisakah saya mengakses data pelacakan historis melalui API?
Ya, Platform API dapat menyediakan akses ke data pelacakan historis, bergantung pada metode dan izin yang tersedia.
Misalnya, metode GET /partner/units/{id}/messages mengambil pesan dari sebuah Unit. Jumlah pesan maksimum yang dapat diambil adalah 10.000. Anda juga dapat menentukan jumlah pesan terbaru yang ingin Anda terima.
Contoh permintaan untuk mengambil 10 pesan terakhir:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Kolom pada respons bergantung pada parameter yang dikirim oleh perangkat pelacak.
Bagaimana cara mengambil data telemetri?
Untuk mendapatkan data telemetri terbaru untuk sebuah Unit, gunakan metode GET /partner/units/{id}/telemetry. Respons berisi pesan telemetri terbaru yang tersedia untuk Unit yang ditentukan. Kolom yang tepat bergantung pada data yang dikirim oleh perangkat pelacak.
Contoh permintaan:
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Bagaimana cara mulai menggunakan API?
Untuk meminta akses API, cukup masuk ke Akun Console Anda. Jika belum memilikinya, Anda juga dapat mendaftar di sini.