IoT Platform:Custom service API

Prasyarat

Anda telah membuat metric dan tabel penyimpanan untuk sumber data Anda. Untuk informasi selengkapnya, lihat Metric overview dan Custom storage tables.

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

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

3. Pada halaman Data API, klik tab custom service API, lalu klik Create API.

4. Pada wizard Create API, konfigurasikan pengaturan pada bagian API basic information, lalu klik Next.

   Parameter	Deskripsi
   API name	Masukkan nama API. Nama dapat berisi karakter Tionghoa, huruf, angka, garis bawah (_), dan tanda hubung (-), serta panjangnya maksimal 30 karakter.
   API path	Masukkan path API. Path ini berfungsi sebagai pengenal resource unik dalam instans. Saat memanggil API, nilai parameter permintaan apiPath harus sesuai dengan path ini. Path harus diawali dengan garis miring (/) dan dapat berisi huruf, angka, garis bawah (_), dan garis miring (/). Panjang path maksimal 128 karakter. Contoh: /pk/temperatureMax. Penting Anda tidak dapat mengubah API path setelah API dipublikasikan.
   API tag	Masukkan konten tag, lalu tekan Enter. Tag dapat berisi karakter Tionghoa, huruf, angka, garis bawah (_), dan tanda hubung (-), serta panjangnya maksimal 30 karakter. Gunakan tag sebagai pengenal kustom untuk membantu Anda mengelola API. Penting Anda dapat menambahkan maksimal lima tag ke satu API.
   API description	Masukkan deskripsi API, seperti tujuan dan kemampuannya.
   Response format	Format data respons tetap dalam bentuk JSON.

5. Pada halaman Configure and test parameters, lengkapi pengaturan berikut.

   Kategori	Parameter	Deskripsi
   Data source	Metric	Pilih metric field dan dataset tertentu. dataset adalah organisasi objek tertentu dalam suatu metric field, misalnya produk tertentu dalam field produk atau perangkat tertentu dalam field perangkat. Untuk informasi selengkapnya tentang metric, lihat What is a metric?.
   	Storage table	Pilih tabel penyimpanan kustom yang dihasilkan oleh tugas parsing data atau analisis SQL. Untuk informasi selengkapnya, lihat Cold storage table.
   Configure parameters	Dataset	Pengaturan ini hanya muncul setelah Anda memilih Metric sebagai data source dan menentukan metric field serta dataset. Klik Preview Data untuk membuka halaman detail sumber data yang dipilih.
   	Data scope	Pengaturan ini hanya ditampilkan jika Anda memilih Metric sebagai data source. Pilih cakupan data untuk API: derived metric: Data yang diperoleh dari metric mentah, definisi asli, dan definisi turunan menggunakan perhitungan agregat seperti jumlah dan rata-rata. derived definition: Metric yang diturunkan dari definisi asli dan diterapkan pada sub-entitas. Untuk informasi selengkapnya tentang derived metric dan definisi, lihat Metric types.
   	Request parameters	Klik Add Parameter untuk menambahkan metric dari sumber data yang dipilih sebagai parameter permintaan API. Hanya field sistem dan field kunci utama (primary key) dari tabel penyimpanan kustom yang didukung. Untuk setiap parameter, Anda harus mengonfigurasi field binding-nya, nama, tipe, operator, apakah wajib diisi, contoh nilai, dan deskripsinya. Penting Jika tipe parameter berupa angka, operator LIKE tidak didukung.
   	Response parameters	Klik Add Parameter untuk menambahkan metric dari sumber data yang dipilih sebagai parameter respons API. Untuk setiap parameter, Anda harus mengonfigurasi prioritasnya, field binding, nama, tipe, apakah digunakan untuk pengurutan, contoh nilai, dan deskripsinya. Pilih kotak centang Select All Parameters di sebelah kanan untuk menyertakan semua field tabel dalam respons API. Catatan Mengurutkan hasil berdasarkan field ini secara ascending atau descending. Setiap metric hanya dapat dikonfigurasi sebagai satu parameter respons.
   	Sort order	Pilih urutan pengurutan parameter. Ascending (default): Parameter diurutkan secara ascending. Descending: Parameter diurutkan secara descending.
   Advanced Settings	Enable paginated response	Tentukan apakah akan mengaktifkan pagination untuk respons. Disabled: Mengembalikan maksimal 100 hasil. Enabled: Mengembalikan semua hasil dalam bentuk halaman. Jika fitur ini diaktifkan, parameter umum berikut akan ditambahkan secara otomatis: pageNum: Nomor halaman. pageSize: Ukuran halaman. Nilai maksimumnya adalah 100.
   	Timeout error setting	Jika pemanggilan API melebihi 8 detik, error timeout akan dikembalikan. Pengaturan ini tidak dapat diubah.

   Setelah menyelesaikan pengaturan, masukkan nilai uji untuk parameter permintaan di bagian Test API, lalu klik Start Test.

   Lihat data sampel pada tab Response Example atau klik Request Details untuk melihat informasi permintaan spesifik. Jika pengujian berhasil, tab Response Example akan menampilkan respons JSON, termasuk field seperti errCode:0 dan errMsg:"success". Pesan Test succeeded beserta durasi pemanggilan API akan muncul di bagian bawah.

6. Klik Publish.

   Penting

   • Sebelum mempublikasikan API, pastikan API telah lulus pengujian.

   • Jika Anda hanya mengklik Save, API akan disimpan dengan status offline.

   • Untuk API dengan konfigurasi yang belum lengkap, Anda dapat mengklik Edit untuk melengkapi konfigurasi, lalu mempublikasikannya.

   • Anda hanya dapat menghapus API yang berstatus offline.

   Pada halaman Published successfully, klik Create Another untuk membuat API kustom lainnya atau klik View in List untuk melihat API tersebut dalam daftar.

Langkah selanjutnya

Setelah membuat custom service API, Anda dapat memanggilnya untuk mengambil data. Untuk petunjuknya, lihat Manage and use APIs.

Contoh pemanggilan tersedia di:

• Java SDK call example

• Node.js SDK call example