← Kembali ke Dokumentasi

Referensi API ringkas

Konvensi

  • Base URL: https://app.include.co.id/api/v1
  • Autentikasi pengguna: Authorization: Bearer <access_token>, didapat dari POST /auth/login.
  • Autentikasi perangkat: device token, hanya untuk route /device/* dan /{token}/*.
  • Respons sukses: { data, meta }. Respons error: { error, message }.
  • Hampir semua data berada di dalam satu grup (group_id) di organisasi Anda.

Endpoint utama

  • GET /devices, GET /devices/:id, PATCH /devices/:id: daftar dan ubah perangkat.
  • POST /devices/claim: klaim perangkat dengan ID atau token.
  • POST /devices/custom: daftarkan perangkat sendiri (BYOD).
  • POST /devices/:id/command: kirim perintah ke aktuator.
  • GET /telemetry/:deviceId: nilai terakhir.
  • GET /telemetry/:deviceId/history: riwayat, dengan startTime, endTime, limit.
  • POST /telemetry/:deviceId/import: impor data historis (paket Pro ke atas; tidak memicu alarm).
  • GET /telemetry/stream: aliran data real-time (Server-Sent Events).
  • GET /alarms, PATCH /alarms/:id/acknowledge, PATCH /alarms/:id/resolve: kelola alarm.
  • POST /devices/:id/thresholds: atur ambang optimal, warning, dan critical per parameter.
  • GET /rule-chains, POST /rule-chains, POST /rule-chains/test: otomasi, termasuk uji coba tanpa data nyata.

Butuh akses API untuk integrasi ERP atau sistem lain? Hubungi tim kami.