IoT Platform:API data produk

Prasyarat

Anda telah membuat produk dan perangkat. Untuk informasi selengkapnya, lihat Create a product dan Create a device.

Buat API data produk

1. Di IoT Platform console, buka halaman Overview, lalu klik ID atau alias instans Edisi Perusahaan yang dituju.

2. Pada panel navigasi kiri, pilih Data Service > Data API.

3. Klik tab Product Data API, lalu klik Create API.

4. Pada panel Create API, centang kotak di samping produk yang dituju.

5. Klik Apply.

   API data snapshot dan API data mentah untuk produk tersebut ditambahkan ke daftar API data produk.

   Parameter	Snapshot data API	Raw data API	Event data API
   API name	${productName} product snapshot data query	${productName} product raw data query	${productName} product event data query
   API Path	/${productKey}/snapshot/data/get	/${productKey}/rawdata/get	/${productKey}/event/data/get

   ${productName} adalah nama produk, dan ${productKey} adalah pengenal unik produk tersebut.

Edit API data produk

Untuk API kueri data snapshot dan mentah, Anda dapat mengedit nama API, parameter permintaan, dan parameter respons.

1. Pada halaman Data API, klik tab Product Data API.

2. Pada daftar API, temukan API kueri data snapshot atau mentah untuk produk yang dituju, lalu klik Edit di kolom Actions.

3. Pada wizard Edit API, ubah API Basic Information, lalu klik Next.

   Parameter	Description
   API name	Ubah nama API. Nama dapat berisi karakter Tionghoa, huruf, angka, garis bawah (_), dan tanda hubung (-). Panjang nama maksimal 30 karakter.
   API Path	Parameter ini tidak dapat diubah.
   API tags	Masukkan konten tag lalu tekan Enter untuk membuat tag. Tag dapat berisi karakter Tionghoa, huruf, angka, garis bawah (_), dan tanda hubung (-). Panjang setiap tag maksimal 30 karakter. Gunakan tag untuk menambahkan ID kustom pada API Anda guna memudahkan manajemen. Penting Anda dapat menambahkan maksimal lima tag ke satu API.
   API description	Masukkan deskripsi API untuk menjelaskan fitur dan informasi lainnya.
   Return type	Format data yang dikembalikan setelah API dipanggil. Nilainya tetap JSON.

4. Pada halaman Configure Parameters and Test, ubah parameter konfigurasi dan pengaturan advanced.

   Category	Configuration item	Description
   Configuration parameters	Request parameters	Klik Add Parameter lalu pilih Bound Field. Untuk parameter yang ditambahkan, Anda dapat mengatur operator, menentukan apakah parameter tersebut wajib diisi, serta memberikan nilai sampel dan deskripsi. Untuk menghapus parameter, klik ikon hapus . Penting Jika tipe parameter berupa numerik, operator LIKE tidak didukung.
   	Response parameters	Semua bidang yang dapat dikembalikan oleh API dipilih secara default. Anda dapat menentukan apakah suatu bidang digunakan untuk sorting serta memberikan nilai sampel dan deskripsi. Untuk menghapus parameter, klik ikon hapus . Setelah menghapus parameter, Anda dapat mengklik Add Parameter untuk menambahkan kembali bound field sebagai parameter respons. Anda juga dapat mencentang kotak Select All Parameters di sebelah kanan untuk memilih ulang semua bidang sebagai parameter respons. Catatan Used for Sorting menentukan bahwa data yang dikueri diurutkan berdasarkan nilai bidang ini secara ascending atau descending sebelum hasil kueri dikembalikan.
   	Sort order	Pilih urutan pengurutan parameter. Ascending (default): Parameter diurutkan secara ascending. Descending: Parameter diurutkan secara descending.
   Advanced Settings	Enable paging for results	Pilih apakah akan mengaktifkan paging untuk hasil yang dikembalikan. Disabled: Anda dapat melihat maksimal 100 hasil. Enabled: Anda dapat melihat semua hasil secara bertahap. Jika Anda mengaktifkan fitur ini, parameter umum berikut akan ditambahkan secara otomatis: pageNum: Nomor halaman. pageSize: Jumlah hasil yang ditampilkan per halaman. Nilai maksimum adalah 100.
   	Timeout error settings	Jika permintaan pemanggilan API melebihi 8000 milidetik, error timeout akan dikembalikan. Parameter ini tidak dapat diubah.

5. Setelah menyelesaikan konfigurasi, pada bagian Test API, masukkan nilai uji untuk parameter permintaan, lalu klik Start Test.

   Anda dapat melihat data sampel pada tab Response Example atau melihat detail permintaan pada tab Request Details.

   Parameter permintaan mencakup pageNum (INTEGER), pageSize (INTEGER), timestamp (BIGINT, wajib diisi), dan device_name (VARCHAR). Data berformat JSON pada contoh respons berisi bidang yang terkait dengan status daya dan cahaya perangkat IoT, seperti date_time, ActivePower, LightVolt, PowerRatio, DrainVoltage, PowerConsumption, LightAdjustLevel, timestamp, device_name, iot_id, LightCurrent, dan LightStatus.

6. Klik Publish.

   Penting

   • Pastikan API telah lolos pengujian sebelum dipublikasikan.

   • Jika Anda hanya mengklik Save untuk suatu API, Status-nya pada halaman API Details akan menjadi Unpublished.

   • API harus dipublikasikan terlebih dahulu sebelum dapat dipanggil untuk mengkueri data.

   Setelah API dipublikasikan, pesan sukses akan muncul dan API Name serta API Path ditampilkan. Anda dapat mengklik Copy untuk menyalin path tersebut. Contoh pemanggilan untuk Java SDK, Node.js SDK, dan Python SDK disediakan di bagian bawah halaman. Anda dapat mengklik View List untuk kembali ke daftar API atau mengklik Create Again untuk membuat API lain.

Langkah selanjutnya

• Panggil API data produk untuk melihat data mentah, snapshot, dan event dari perangkat tertentu dalam suatu produk.

  Untuk contoh pemanggilan, lihat:

  • Java SDK call example

  • Node.js SDK call example

• Lihat penggunaan API di halaman API Details. Untuk informasi selengkapnya, lihat Melihat API.