DataWorks:Mulai Menggunakan

Pengembangan API

Data Push

DataService Studio di DataWorks mendukung fitur Data Push, yang mendorong konten data ke grup target sesuai jadwal. Anda dapat menggunakan tugas Data Push untuk mengatur konten dorong, seperti teks kaya dan tabel, dari berbagai sumber data. Anda dapat menetapkan frekuensi dorong berulang berdasarkan kebutuhan bisnis dan menentukan objek serta saluran dorong untuk berbagai konsumen data. Hal ini membantu meningkatkan efisiensi pengiriman data dan memperluas skenario konsumsi data. Untuk informasi selengkapnya, lihat Data Push.

Langkah 1: Buat sumber data dan konfigurasikan konektivitas jaringan

Sebelum membuat API di DataService Studio, Anda harus menambahkan database atau gudang data Anda sebagai sumber data DataWorks. Anda juga harus memastikan bahwa kelompok sumber daya DataService Studio dapat terhubung ke sumber data tujuan agar DataWorks dapat mengakses sumber data tersebut selama panggilan API.

Selama pengembangan API, DataService Studio mengakses sumber data ini untuk mengambil informasi skema tabel data. Hal ini memungkinkan Anda mengatur parameter permintaan dan respons. Saat API dipanggil, DataService Studio mengakses sumber data untuk menjalankan kueri. Untuk daftar sumber data yang didukung, lihat Daftar sumber data untuk DataService Studio.

Topik ini menggunakan sumber data MySQL bernama rds_workshop_log sebagai contoh dan menjelaskan cara menguji konektivitasnya dengan grup sumber daya publik untuk DataService Studio.

1. Buka Pusat Manajemen DataWorks, pilih ruang kerja tujuan, lalu klik Go to Management Center.

2. Di panel navigasi kiri, klik Data Source untuk membuka halaman pengelolaan sumber data.

3. Buat sumber data dan uji konektivitas jaringannya.

   1. Klik Add Data Source dan pilih tipe sumber data.

      Topik ini menggunakan MySQL sebagai contoh.

   2. Konfigurasikan informasi sumber data.

      Konfigurasikan parameter sesuai petunjuk di halaman. Untuk informasi selengkapnya, lihat Konfigurasikan sumber data MySQL.

   3. Pilih kelompok sumber daya Serverless dan uji konektivitas antara kelompok sumber daya dan sumber data.

      Catatan

      • Jika Anda memiliki tugas konkurensi tinggi yang tidak dapat dijalankan selama jam sepi, gunakan sumber daya khusus untuk mendukung panggilan API dengan konkurensi dan frekuensi tinggi. Kami menyarankan Anda membeli dan menggunakan kelompok sumber daya Serverless dari DataWorks.

      • Saat menggunakan kelompok sumber daya Serverless, Anda harus mengonfigurasi kuota untuk DataService Studio dalam kelompok sumber daya Serverless.

      • Jika pengujian konektivitas gagal, periksa konfigurasinya. Untuk informasi selengkapnya, lihat Koneksi jaringan dan daftar putih.

   4. Klik Complete untuk membuat sumber data.

Langkah 2: Buat grup API

DataService Studio menyediakan layanan ke sistem eksternal melalui API Gateway. Di API Gateway, grup merupakan unit pengelolaan untuk API dan dikaitkan dengan nama domain alamat panggilan. Oleh karena itu, Anda harus terlebih dahulu membuat grup API di API Gateway sebelum membuat API di DataService Studio.

1. Buka konsol API Gateway. Di halaman Manajemen Grup, klik Create Group.

2. Masukkan informasi grup dan buat grup tersebut. Topik ini menggunakan grup bernama Workshop sebagai contoh.

Langkah 3: Buat proses bisnis

Di DataService Studio, proses bisnis digunakan untuk mengembangkan API berdasarkan unit bisnis serta mengorganisasi dan mengelola file, seperti API dan fungsi. Oleh karena itu, Anda harus terlebih dahulu membuat proses bisnis sebelum membuat API.

1. Login ke Konsol DataWorks. Di bilah navigasi atas, pilih wilayah yang diinginkan. Di panel navigasi kiri, pilih Data Analysis and Service > DataService Studio. Di halaman yang muncul, pilih ruang kerja yang diinginkan dari daftar drop-down dan klik Go to DataService Studio.

2. Buat proses bisnis.

   Di halaman DataService Studio > Service Development, Anda dapat membuat proses bisnis dengan salah satu cara berikut:

   • Metode 1: Klik ikon dan pilih Create Business Process.

   • Metode 2: Di panel navigasi kiri, klik kanan folder Business Process dan pilih Create Business Process.

3. Konfigurasikan parameter untuk proses bisnis.

   Konfigurasi	Deskripsi
   Business Name	Masukkan nama kustom berdasarkan skenario bisnis Anda. Topik ini menggunakan DataService sebagai contoh.
   API Group	Pilih grup API untuk mengelola API Anda. Topik ini menggunakan grup Workshop yang dibuat di Langkah 2. Catatan Grup API adalah kumpulan API untuk fitur atau skenario tertentu. Grup ini juga merupakan unit terkecil untuk pengelolaan API di API Gateway. Untuk membuat grup baru, lihat Langkah 2: Buat grup API.

4. Klik OK untuk membuat proses bisnis.

   Setelah proses bisnis dibuat, Anda dapat melihat detailnya di folder di panel navigasi kiri halaman DataService Studio.

Langkah 4: Hasilkan API

Setelah membuat proses bisnis, Anda dapat membuat API di dalam proses tersebut.

1. Hasilkan API.

   Di halaman DataService Studio > Service Development, Anda dapat menghasilkan API dengan salah satu cara berikut:

   • Metode 1: Klik ikon dan pilih Create API > Generate API.

   • Metode 2: Di panel navigasi kiri, klik kanan proses bisnis tujuan dan pilih New > API > Generate API.

2. Tentukan properti API.

   Di kotak dialog Generate API, konfigurasikan informasi API. Gambar berikut menunjukkan contoh konfigurasi. Tabel berikut menjelaskan parameter utama.

   Item Konfigurasi	Deskripsi
   Destination Folder	Tentukan folder tempat API disimpan dalam proses bisnis di sebelah kiri. Klik teks untuk memilih folder. Penting Kami menyarankan Anda memilih folder tujuan terlebih dahulu. Jika Anda tidak dapat memilih folder, buat proses bisnis terlebih dahulu.
   API Mode	Pilih mode untuk membuat API. Anda dapat memilih antarmuka tanpa kode atau editor kode. Antarmuka tanpa kode: Konfigurasikan API data secara cepat tanpa menulis kode. Editor kode: Mendukung fitur tingkat lanjut seperti penggabungan tabel, kueri kompleks, dan fungsi agregat. Anda dapat menulis kueri SQL kustom untuk API guna memenuhi kebutuhan kueri tingkat lanjut. Contoh dalam topik ini menggunakan antarmuka tanpa kode. Untuk informasi selengkapnya tentang kedua pola tersebut, lihat Ikhtisar Hasilkan API.
   API Name	Masukkan nama kustom untuk API. Topik ini menggunakan rpt_user_info_all_d sebagai contoh.
   API Path	Jalur penyimpanan API. Ini adalah URI permintaan relatif terhadap host layanan. Jalur ini digunakan untuk menyusun alamat panggilan API. Topik ini menggunakan /user sebagai contoh.
   Protocol	HTTP dan HTTPS didukung. Untuk memanggil API melalui HTTPS, bind nama domain independen dan unggah Sertifikat SSL di konsol API Gateway setelah Anda mempublikasikan API ke gateway. Untuk informasi selengkapnya, lihat Dukungan untuk HTTPS.
   Request Method	GET dan POST didukung. Catatan Jika Anda memilih GET, Anda hanya dapat mengatur Parameter Position dari Request Parameters ke QUERY. Jika Anda memilih POST, Anda dapat mengatur Parameter Position dari Request Parameters ke QUERY atau BODY.
   Response Type	Hanya JSON yang didukung.
   Visible Scope	Tentukan visibilitas API setelah dibuat. Nilai yang valid adalah Workspace dan Private. Workspace: API terlihat oleh semua anggota di ruang kerja saat ini. Private: API hanya terlihat oleh pemilik API. Otorisasi tidak didukung. Topik ini menggunakan Workspace sebagai contoh.

3. Konfigurasikan parameter API.

   Di halaman pengeditan API, konfigurasikan parameter API. Gambar berikut menunjukkan contoh konfigurasi.

   1. Pilih sumber data untuk API.

      Di bagian Select Table, pilih tabel sumber data yang ingin Anda gunakan untuk menghasilkan API.

      Parameter	Deskripsi
      Data Source Type	Pilih tipe sumber data tempat Anda akan membuat API. Topik ini menggunakan MySQL sebagai contoh.
      Data Source Name	Nama sumber data dari tipe yang dipilih sebagai dasar untuk menghasilkan API. Topik ini menggunakan sumber data rds_workshop_log yang dibuat di Bagian 1: Buat sumber data dan konfigurasikan konektivitas jaringan sebagai contoh.
      Data Source Environment	Ruang kerja dalam mode standar mendukung akses ke sumber data di lingkungan pengembangan atau produksi. Untuk informasi selengkapnya tentang perbedaan antara kedua lingkungan tersebut, lihat Ruang kerja mode dasar vs. mode standar. Topik ini menggunakan Production Environment sebagai contoh.
      Data Table Name	Pilih tabel data di sumber data tempat Anda akan menghasilkan API. Topik ini menggunakan tabel rpt_user_info_all_d di sumber data rds_workshop_log sebagai contoh.

   2. Tentukan parameter permintaan dan respons.

      Setelah memilih tabel data, bagian Select Parameters secara otomatis menampilkan semua bidang dari tabel tersebut. Pilih bidang yang akan digunakan sebagai parameter permintaan dan respons untuk API. Untuk mengurutkan bidang, tambahkan bidang target ke bagian Sort Fields dan sesuaikan urutannya.

      Dalam contoh ini, parameter permintaan adalah uid, dan parameter respons adalah semua bidang di tabel.

      Catatan

      Di panel navigasi kanan, klik Request Parameters atau Response Parameters untuk memodifikasi pengaturan parameter, seperti tipe bidang, nilai contoh, dan nilai default. Anda dapat mengonfigurasi pengaturan ini sesuai kebutuhan.

4. Konfigurasikan kelompok sumber daya API.

   Di halaman pengeditan API, klik Service Resource Group di sebelah kanan untuk mengonfigurasi kelompok sumber daya. Karena grup sumber daya publik untuk DataService Studio akan dihentikan, Anda harus mengonfigurasi API baru untuk menggunakan kelompok sumber daya layanan eksklusif. Pilih salah satu dari kelompok sumber daya Serverless (direkomendasikan) yang telah memiliki kuota yang dikonfigurasi untuk DataService Studio atau grup sumber daya eksklusif untuk DataService Studio.

Langkah 5: Uji API

Setelah membuat API, Anda harus mengujinya sebelum dapat mempublikasikannya. Klik Test di pojok kanan atas halaman pengeditan API untuk memverifikasi bahwa permintaan dan nilai kembali sesuai harapan. Dalam contoh ini, atur nilai parameter permintaan uid menjadi 0016359810821 dan uji hasilnya. Untuk informasi selengkapnya tentang pengujian, lihat Uji API.

Langkah 6: Publikasikan API

Anda harus mempublikasikan API setelah lulus pengujian. Setelah API dipublikasikan, layanan lain dapat memanggilnya. Di pojok kanan atas halaman pengeditan API, klik Submit dan pilih versi yang akan dipublikasikan. Setelah API dipublikasikan, Anda dapat melihatnya di API Gateway. Untuk informasi selengkapnya tentang penerbitan, lihat Publikasikan API.

Langkah 7: Panggil API

Metode autentikasi berikut didukung untuk memanggil API. Anda dapat memilih salah satu berdasarkan kebutuhan:

• Simple Authentication: Menawarkan keamanan rendah. Cocok untuk skenario seperti laporan dan dasbor data.

• Encrypted Signature Authentication: Menawarkan keamanan tinggi. Cocok untuk skenario pengembangan aplikasi.

1. Di bilah menu atas DataService Studio, klik Service Management untuk membuka halaman pengelolaan layanan.

2. Di panel navigasi kiri, pilih API Invocation.

   API yang telah dipublikasikan tersedia di API Gateway. Anda dapat memanggil API menggunakan SDK API Gateway. Untuk informasi selengkapnya, lihat Contoh pemanggilan API dari klien.

Langkah 8: Lihat dan kelola API

Anda dapat melihat dan mengelola API yang telah dipublikasikan di halaman pengelolaan layanan. Di bilah navigasi atas, klik Service Management untuk melihat API yang telah Anda publikasikan dan melakukan operasi pengelolaan terkait.