DataWorks:Mendaftarkan layanan API eksternal

Mendaftarkan API

Jika Anda belum memiliki API, buat terlebih dahulu. Untuk informasi selengkapnya, lihat Buat API dari sumber data (API Gateway).

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

   Atau, Anda dapat membuka proses bisnis terkait, klik kanan API, lalu pilih Create API > Register API.

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

   

   Parameter	Deskripsi
   Location	Direktori tempat API disimpan. Penting Kami menyarankan agar Anda memilih folder tujuan terlebih dahulu. Jika tidak tersedia folder yang dapat dipilih, buat proses bisnis terlebih dahulu.
   API Name	Nama unik untuk API dalam kelompok API Gateway dan ruang kerja.
   APIPath	Jalur untuk API, misalnya /user.
   Protocol	Protokol yang didukung: HTTP dan HTTPS. Jika Anda perlu memanggil API melalui HTTPS, Anda harus memublikasikan API ke API Gateway, mengikat nama domain khusus di konsol API Gateway, dan mengunggah sertifikat SSL. Untuk informasi selengkapnya, lihat Aktifkan HTTPS.
   Request Method	Metode yang didukung: GET, POST, PUT, dan DELETE.
   Response Type	Tipe yang didukung: JSON dan XML.
   Visible Scope	Opsi yang tersedia adalah Work space dan Private. Work space: API terlihat oleh semua anggota dalam ruang kerja saat ini. Private: API hanya terlihat oleh pemilik API. Otorisasi tidak didukung untuk API privat. Catatan Jika Anda mengatur cakupan visibilitas ke private, API hanya terlihat oleh Anda di pohon direktori, dan anggota ruang kerja lain tidak dapat melihatnya.
   Tag	Pilih tag dari daftar Tag.
   Description	Deskripsi API, maksimal 2.000 karakter.

Mengonfigurasi API

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

   

   Parameter	Deskripsi
   Host	Host layanan backend. Nilainya harus diawali dengan http:// atau https:// dan tidak boleh mengandung jalur. Catatan Misalnya, jika URL layanan Anda adalah http://xxx-cn-xxx.alicloudapi.com/user/info, Anda dapat mengatur host layanan backend menjadi http://xxx-cn-xxx.alicloudapi.com. Konfigurasikan parameter ini berdasarkan URL aktual layanan Anda.
   Path	Jalur layanan backend. Anda dapat menyertakan parameter jalur dalam tanda kurung ([]), seperti /user/[userid]. Setelah Anda mengonfigurasi parameter dalam jalur, sistem akan secara otomatis menambahkannya ke daftar parameter permintaan dan mengatur posisi parameternya menjadi PATH. Catatan Misalnya, jika URL layanan Anda adalah http://xxx-cn-xxx.alicloudapi.com/user/info, Anda dapat mengatur jalur layanan backend menjadi /user/info. Konfigurasikan parameter ini berdasarkan URL aktual layanan Anda.
   Back-end Service Timeout	Periode timeout untuk layanan backend.

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

   

   Parameter	Deskripsi
   Request Parameters	Klik Add untuk mengonfigurasi parameter permintaan untuk API. Parameter Position dapat berupa QUERY, HEAD, PATH, atau Body. Posisi yang tersedia bergantung pada metode permintaan yang dipilih. Pilih posisi sesuai kebutuhan Anda.
   Constant Parameters	Parameter konstan memiliki nilai tetap dan disembunyikan dari pemanggil API. Pemanggil tidak perlu mengirimkan parameter ini, tetapi layanan backend selalu menerimanya dengan nilai yang telah dikonfigurasi.
   Request body definition	Bagian ini hanya muncul ketika metode permintaan adalah POST atau PUT. Anda dapat memberikan contoh badan permintaan dalam format JSON atau XML untuk menunjukkan kepada pemanggil cara menyusun permintaan.

3. Pada bagian Define Response Content, berikan Correct Response Example dan Error Response Example. Contoh-contoh ini membantu pemanggil API memahami format respons dan menulis kode penguraian.

4. Pada bagian Error Code Definition, definisikan Error Code, Error message, dan Solution untuk potensi kesalahan. Informasi ini membantu pemanggil API mendiagnosis dan menyelesaikan masalah secara mandiri.

5. Klik ikon di bilah alat atas untuk menyimpan API.