View a markdown version of this page

Integrasi koneksi REST API - Amazon Quick
Yang dapat Anda lakukanSebelum Anda mulaiSiapkan titik akhir dan otentikasi APISiapkan integrasi REST APITindakan tugas yang tersediaOpsi konfigurasi APIKelola integrasi REST API

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Integrasi koneksi REST API

Dengan integrasi REST API Connection di Amazon Quick, Anda dapat melakukan tindakan dengan API REST kustom dan layanan web. Integrasi ini hanya mendukung eksekusi tindakan.

Yang dapat Anda lakukan

Dengan integrasi REST API Connection, Anda dapat melakukan tindakan dengan API REST kustom dan layanan web melalui konektor tindakan.

Konektor aksi

Lakukan permintaan HTTP, ambil data, dan berinteraksi dengan API menggunakan opsi otentikasi fleksibel.

catatan

Integrasi REST API Connection tidak mendukung akses data atau pembuatan basis pengetahuan. Ini dirancang khusus untuk eksekusi tugas dan interaksi API dengan layanan web khusus.

Sebelum Anda mulai

Sebelum Anda mengatur integrasi REST API, pastikan Anda memiliki yang berikut:

  • Titik akhir REST API dengan izin akses yang sesuai.

  • Kredensi otentikasi API (OAuth, kunci API, atau lainnya).

  • Dokumentasi API untuk layanan web target.

Siapkan titik akhir dan otentikasi API

Sebelum mengonfigurasi integrasi di Amazon Quick, siapkan titik akhir REST API dan kredensial autentikasi Anda. Integrasi REST API Connection mendukung beberapa metode otentikasi. Pilih metode yang sesuai dengan persyaratan API Anda:

Otentikasi pengguna (OAuth)

Kumpulkan informasi berikut dari penyedia API Anda:

  • URL Dasar - URL dasar REST API.

  • ID Klien - ID klien aplikasi OAuth.

  • Rahasia Klien - Rahasia klien aplikasi OAuth.

  • URL Token - Titik akhir token OAuth.

  • URL Auth - Titik akhir otorisasi OAuth.

  • URL pengalihan - URI pengalihan OAuth.

Otentikasi layanan (Service-to-service OAuth)

Kumpulkan informasi berikut dari penyedia API Anda:

  • Jenis otentikasi - Alur pemberian kredensi klien OAuth 2.0 untuk otentikasi layanan-ke-layanan.

  • URL Dasar - URL dasar REST API.

  • ID Klien - pengenal klien aplikasi OAuth untuk otentikasi layanan.

  • Rahasia klien - Rahasia klien aplikasi OAuth untuk otentikasi layanan.

  • URL Token - titik akhir token OAuth untuk mendapatkan token akses.

Header dan parameter khusus

Anda dapat menggunakan header dan parameter khusus untuk otentikasi fleksibel dan interaksi API:

  • Header otentikasi kustom.

  • Header versi API.

  • Content-Type spesifikasi.

  • Parameter kueri kustom.

Siapkan integrasi REST API

Setelah menyiapkan endpoint API dan kredensial autentikasi, ikuti langkah-langkah berikut untuk membuat integrasi REST API:

  1. Di konsol Amazon Quick, pilih Konektor.

  2. Pilih tab Buat untuk tim Anda.

  3. Temukan dan pilih REST API Connection.

  4. Isi detail integrasi:

    • Nama - Nama deskriptif untuk integrasi REST API Anda.

    • Deskripsi (Opsional) - Tujuan integrasi.

  5. Pilih jenis koneksi Anda:

    • Otentikasi pengguna - OAuth-based otentikasi untuk akses pengguna individu.

    • Otentikasi layanan - Autentikasi berbasis kunci API untuk akses layanan.

  6. Isi pengaturan koneksi berdasarkan metode otentikasi yang Anda pilih (baik pengguna atau layanan).

  7. Pilih Selanjutnya.

  8. Tinjau tindakan yang tersedia.

  9. Pilih Buat dan lanjutkan.

Tindakan tugas yang tersedia

Setelah membuat integrasi REST API, Anda dapat meninjau tindakan yang tersedia untuk berinteraksi dengan REST API. Tindakan REST API yang umum meliputi:

  • Permintaan HTTP GET untuk pengambilan data.

  • Permintaan HTTP POST untuk pembuatan data.

  • PUT/PATCH Permintaan HTTP untuk pembaruan data.

  • Permintaan HTTP DELETE untuk penghapusan data.

  • Interaksi titik akhir kustom.

  • Pemrosesan data JSON dan XHTML.

  • Parameter kueri dan manajemen header.

catatan

Tindakan spesifik yang tersedia bergantung pada titik akhir REST API dan izin otentikasi yang dikonfigurasi untuk integrasi Anda.

Opsi konfigurasi API

Anda dapat mengonfigurasi berbagai aspek integrasi REST API agar sesuai dengan kebutuhan spesifik Anda.

Konfigurasi titik akhir

Konfigurasikan pengaturan titik akhir ini:

  • URL dasar dan jalur titik akhir.

  • Spesifikasi metode HTTP.

  • Penanganan format permintaan dan respons.

  • Penanganan kesalahan dan coba lagi logika.

Penanganan data

Konfigurasikan cara integrasi Anda memproses format data yang berbeda:

  • Permintaan JSON dan pemrosesan respons.

  • Transformasi data XML.

  • Formulir data dan unggahan multipart.

  • Penanganan data biner.

Kelola integrasi REST API

Setelah membuat integrasi REST API, Anda dapat mengelolanya menggunakan opsi berikut:

  • Edit integrasi - Perbarui pengaturan otentikasi, URL dasar, atau konfigurasi API.

  • Integrasi berbagi - Buat integrasi tersedia untuk pengguna lain di organisasi Anda.

  • Memantau penggunaan - Lihat aktivitas integrasi dan metrik panggilan API.

  • Tinjauan tindakan - Lihat daftar lengkap tindakan REST API yang tersedia.

  • Uji titik akhir - Validasi konektivitas dan otentikasi API.

  • Hapus integrasi - Hapus integrasi dan cabut otentikasi terkait.

penting

Integrasi REST API bergantung pada ketersediaan dan konfigurasi layanan web target. Perubahan pada API atau persyaratan otentikasi dapat memengaruhi fungsionalitas integrasi.