DataWorks：Daftarkan layanan API eksternal

Daftarkan API

Jika Anda belum memiliki API, buat terlebih dahulu. Untuk informasi selengkapnya, lihat Buat API di antarmuka tanpa kode.

1. Pada halaman Service Development, klik ikon lalu pilih New API > Register API.

   Anda juga dapat membuka business process, klik kanan API, lalu pilih New API > Register API.

2. Pada kotak dialog Register API, konfigurasikan parameter berikut.

   

   Parameter	Deskripsi
   Destination Folder	Folder tempat API disimpan. Klik teks tersebut untuk memilih folder. Penting Pilih destination folder terlebih dahulu. Jika Anda tidak dapat memilih folder, buat business process.
   API Name	Nama kustom untuk API. Nama ini harus unik dalam kelompok gerbang API dan ruang kerja.
   API Path	Jalur tempat API disimpan. Contoh: /user.
   Protocol	Protokol yang didukung adalah HTTP dan HTTPS. Jika Anda ingin memanggil API melalui HTTPS, publikasikan API ke gerbang. Kemudian, bind nama domain independen di Konsol API Gateway dan unggah Sertifikat SSL. Untuk informasi selengkapnya, lihat Dukungan HTTPS.
   Request Method	Metode yang didukung adalah GET, POST, PUT, dan DELETE.
   Return type	Format yang didukung adalah JSON dan XML.
   Visible Scope	Cakupan visibilitas dapat berupa Workspace atau Private. Workspace: API terlihat oleh semua anggota di workspace saat ini. Private: API hanya terlihat oleh pemiliknya. Anda tidak dapat memberikan izin API kepada anggota lain. Catatan Jika Anda mengatur visible scope ke Private, API hanya terlihat oleh Anda di pohon direktori. Anggota lain dalam ruang kerja tidak dapat melihatnya.
   Label	Pilih tag dari daftar Label.
   Description	Deskripsi singkat tentang API. Deskripsi tidak boleh melebihi 2.000 karakter.

Konfigurasikan API

1. Klik ganda API yang telah didaftarkan untuk membuka halaman konfigurasinya. Pada bagian Define Backend Service, konfigurasikan parameter berikut.

   

   Parameter	Deskripsi
   Backend Service Host	Host layanan API yang ingin Anda daftarkan. Host harus diawali dengan http:// atau https:// dan tidak boleh mengandung jalur (path). Catatan Contoh: Jika URL layanan API Anda adalah http://xxx-cn-xxx.alicloudapi.com/user/info, Anda dapat mengatur backend service host menjadi http://xxx-cn-xxx.alicloudapi.com. Konfigurasikan parameter ini sesuai dengan jalur aktual layanan API Anda.
   Backend Service Path	Jalur layanan API yang ingin Anda daftarkan. Jalur ini dapat berisi parameter yang diapit tanda kurung siku ([]), seperti /user/[userid]. Setelah Anda mengonfigurasi parameter dalam jalur, sistem secara otomatis menambahkan parameter jalur tersebut ke daftar parameter permintaan pada langkah berikutnya di wizard pendaftaran API. Catatan Contoh: Jika URL layanan API Anda adalah http://xxx-cn-xxx.alicloudapi.com/user/info, Anda dapat mengatur backend service path menjadi /user/info. Konfigurasikan parameter ini sesuai dengan jalur aktual layanan API Anda.
   Backend Timeout	Periode timeout untuk layanan backend.

2. Pada bagian Define Request Parameters, konfigurasikan parameter berikut.

   

   Parameter	Deskripsi
   Request Parameters	Klik Add Parameter untuk mengonfigurasi parameter permintaan bagi API. Parameter Position dapat berupa QUERY, HEAD, PATH, atau BODY. Metode permintaan yang berbeda mendukung posisi parameter yang berbeda. Pilih posisi dari opsi yang tersedia sesuai kebutuhan.
   Constant Parameters	Parameter dengan nilai tetap yang tidak terlihat oleh pemanggil API. Anda tidak perlu mengirimkan constant parameters saat memanggil API. Namun, layanan backend selalu menerima constant parameters beserta nilainya yang Anda konfigurasikan di sini. Fitur ini berguna ketika Anda perlu menetapkan nilai parameter tertentu dan menyembunyikannya dari pemanggil API.
   Request Body Definition	Parameter ini hanya muncul jika metode permintaan adalah POST atau PUT. Anda dapat memasukkan deskripsi badan permintaan dalam format JSON atau XML. Ini berfungsi sebagai contoh badan permintaan yang dapat dirujuk oleh pemanggil API.

3. Pada bagian Define Response Content, masukkan contoh Normal Response Example dan Error Response Example. Hal ini membantu pemanggil API menulis kode untuk mengurai respons API.

4. Pada bagian Define Error Codes, masukkan Error Code, Error Message, dan Solution untuk pemanggilan API. Hal ini membantu pemanggil API mengidentifikasi penyebab error.

5. Klik ikon di bilah alat untuk menyimpan API.