Lewati ke konten utama

Overview

Pembahasan pada dokumentasi REST API Jitra ini meliputi persyaratan keamanan, otentikasi, pembatasan request, dan cara mengirim request.

REST API Jitra ini memilki beberapa fitur seperti data objek dan lacak posisi.

Persyaratan​

  • Semua request harus menggunakan HTTPS pada port 443
  • Firewall atau proxy harus mengizinkan traffic dari https://public.jitra.io pada port 443

Otentikasi​

Untuk mulai menggunakan API, diperlukan API key yang didapat dari pengaturan akun maka dari itu pastikan kamu sudah terdaftar pada web Jitra.

  • Masuk ke akunmu lalu pergi ke menu pengaturan
  • Pada menu pengaturan pilih sub-menu API Keys (pastikan kamu mempunyai akses)
  • Buat API Key baru dengan mengisi nama dan durasi (hari)
  • Salin dan simpan API Key tersebut karena hanya muncul sekali saat pertama dibuat
  • Gunakan API Key pada request header Authorization dengan value Bearer API_KEY
  • Atau bisa juga pada header X-API-KEY dengan value API_KEY

Pembatasan Request​

Pembatasan request merupakan fitur keamanan dimana jumlah request dari user dibatasi dalam jangka waktur tertentu.

Pada API Jitra kita membatasi sebanyak 10 requests dalam jangka waktu 5 detik, jadi jika ada lebih dari 10 requests dalam jangka waktu 5 detik maka request akan mengembalikan error HTTP 429.

Cara Mengirim Request​

Gunakan URL jitra berikut https://public.jitra.io/v1 lalu di ikuti dengan endpoint dan method dari tiap fitur yang ingin diakses.

Contohnya untuk mengakses data semua object maka gunakan method GET pada endpoint https://public.jitra.io/v1/objects dengan menyertakan header Authorization : Bearer API_KEY.