Integrasi Apigee dengan pemicu API

Panduan memulai ini menunjukkan cara membuat integrasi contoh di Integrasi Apigee. Langkah-langkah berikut menjelaskan cara mengonfigurasi pemicu, tugas, tepi, variabel, dan pemetaan data yang diperlukan untuk menjalankan integrasi lengkap.

Dalam panduan memulai ini, Anda akan mengambil jumlah kunjungan halaman dari API publik, mengubah data ke dalam format yang dapat digunakan, dan mengirim daftar yang dihasilkan ke dalam email, semuanya dari dalam perancang integrasi.

Membuat integrasi baru

Untuk membuat integrasi baru, lakukan langkah-langkah berikut:

  1. Di UI Apigee, pilih Organisasi Apigee.
  2. Klik Develop > Integrations.
  3. Klik Create Integration.
  4. Masukkan nama dan deskripsi dalam dialog Create Integration.

    Untuk panduan memulai ini, masukkan nama my-test-integration dan deskripsi Integration for quickstart.

  5. Pilih region untuk integrasi.
  6. Klik Create untuk membuka editor integrasi.

Menambahkan dan mengonfigurasi pemicu API

Pemicu diperlukan untuk memulai urutan tugas yang membentuk integrasi. Setiap pemicu yang tersedia dapat digunakan untuk memulai integrasi. Untuk panduan memulai ini, gunakan pemicu API.

Untuk mengonfigurasi pemicu API, lakukan hal berikut:

  1. Di editor integrasi, klik Pemicu untuk menampilkan daftar pemicu yang tersedia.
  2. Klik dan tempatkan elemen pemicu API di editor integrasi.
  3. Klik elemen API trigger pada desainer untuk membuka panel konfigurasi pemicu.
  4. Integrasi Apigee secara otomatis mengisi Label, Nama pemicu, dan ID Pemicu pemicu. ID Pemicu adalah buatan mesin dan Anda tidak dapat mengedit nilainya. Namun, Anda dapat mengedit nilai properti Label dan Nama pemicu.

    Perubahan pada properti akan disimpan secara otomatis.

Menambahkan dan mengonfigurasi tugas

Tugas adalah serangkaian langkah yang dapat dieksekusi yang dapat mengambil variabel sebagai input dan menghasilkan variabel sebagai output. Seperti halnya pemicu, setiap tugas yang tersedia dapat digunakan dalam integrasi. Panduan memulai ini menggunakan tugas Call REST Endpoint, Data Mapping, dan Send Email. Detail konfigurasi untuk setiap tugas dijelaskan dalam langkah-langkah di bawah.

Mengonfigurasi tugas Call REST Endpoint

Untuk mengonfigurasi tugas Call REST Endpoint, lakukan langkah berikut:

  1. Pilih Tasks untuk menampilkan daftar tugas yang tersedia.
  2. Klik dan tempatkan elemen Call REST Endpoint di editor integrasi.
  3. Tambahkan koneksi edge dari elemen pemicu API ke elemen Call REST Endpoint dengan mengarahkan kursor ke titik kontrol di elemen API trigger, lalu klik dan tarik garis ke titik kontrol di elemen tugas Call REST Endpoint. Tepi menunjukkan alur kontrol dari pemicu API ke tugas Call REST Endpoint.

    Tepi adalah hubungan antara dua elemen dalam integrasi. Koneksi menunjukkan arah alur kontrol dari satu elemen (tugas atau pemicu) ke elemen lainnya. Untuk mengetahui informasi selengkapnya tentang edge, lihat Edge.

  4. Klik elemen Call REST Endpoint pada desainer untuk membuka panel konfigurasi tugas. Tetapkan properti berikut:
    • Label: Masukkan nama kustom untuk tugas ini. Misalnya, masukkan Call REST Endpoint Task.
    • Autentikasi: Untuk panduan memulai ini, profil autentikasi tidak diperlukan. Untuk informasi selengkapnya tentang penggunaan profil autentikasi untuk kasus penggunaan lainnya, lihat Membuat profil autentikasi di Integrasi Apigee.
    • Input Tugas: Masukkan detail untuk memanggil endpoint REST. Informasi yang dimasukkan di sini digunakan sebagai input untuk tugas Call REST Endpoint. Masukkan informasi berikut:
      • Endpoint base URL: Masukkan https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/desktop/user/Tree/monthly/20201001/20201031. API publik dari wikimedia.org ini menampilkan jumlah kunjungan halaman untuk artikel bernama Tree pada bulan tertentu.
      • HTTP method: Pilih GET menggunakan daftar dropdown.
    • Output Tugas: Di sini, Integrasi Apigee mengisi tiga variabel untuk menyimpan output data respons saat memanggil endpoint REST:
      • responseHeader(Call REST Endpoint): Variabel ini menyimpan data header respons yang terkait dengan tugas Call REST Endpoint. Data variabel adalah jenis String (STR).
      • responseBody(Call REST Endpoint): Variabel ini menyimpan data isi respons yang terkait dengan tugas Call REST Endpoint. Data variabel adalah jenis String (STR).
      • responseStatus(Call REST Endpoint): Variabel ini menyimpan data status respons yang terkait dengan tugas Call REST Endpoint. Data variabel adalah jenis String (STR).
    • Lihat detail setiap variabel dengan mengklik nama variabel di panel konfigurasi tugas. Untuk panduan memulai ini, biarkan nilai default untuk setiap variabel tersebut.
    • Kolom yang tersisa harus berisi nilai default berikut:
      • Ikuti pengalihan: True
      • Tugas akan gagal pada Error HTTP: False
      • Strategi penanganan error
        • Strategi untuk eksekusi sinkron: None
        • Strategi untuk eksekusi asinkron: None

    Perubahan pada properti akan disimpan secara otomatis.

Menambahkan dan mengonfigurasi tugas Pemetaan Data

Untuk mengonfigurasi tugas Pemetaan Data:

  1. Pilih Tasks untuk menampilkan daftar tugas yang tersedia.
  2. Klik dan tempatkan elemen Data Mapping di editor integrasi.
  3. Tambahkan koneksi edge dari elemen Call REST Endpoint ke elemen Data Mapping dengan mengarahkan kursor ke titik kontrol di elemen Call REST Endpoint, lalu mengklik dan menarik garis ke titik kontrol pada elemen tugas Data Mapping. Tepi menunjukkan alur kontrol dari tugas Call REST Endpoint ke tugas Data Mapping.
  4. Klik tugas Data Mapping pada desainer untuk membuka panel konfigurasi tugas.
  5. Klik Open Data Mapping Editor.

    Data Mapping Editor memungkinkan Anda memetakan variabel input ke variabel output yang diinginkan, menggunakan fungsi transformasi yang tersedia. Outputnya kemudian tersedia sebagai variabel untuk pemicu atau tugas integrasi lainnya. Untuk detail selengkapnya tentang meneruskan data sebagai variabel, lihat Menggunakan variabel dalam Integrasi Apigee.

    Untuk panduan memulai ini, buat pemetaan menggunakan responseBody(Call REST Endpoint) sebagai input:

    1. Tarik variabel responseBody dari panel Variables ke baris Input pertama.
    2. Klik + (Add a function) dalam chip variabel responseBody untuk melihat menu drop-down fungsi yang tersedia.
    3. Anda dapat menerapkan sejumlah fungsi untuk mengubah data dalam variabel input.

      Dalam hal ini, Anda dapat mengonversi payload ke JSON, lalu melakukan iterasi pada array respons untuk mendapatkan daftar nama produk yang diperlukan untuk notifikasi email.

      • Pilih TO_JSON() untuk mengonversi string responseBody ke JSON.
      • Klik + (Add a function) dalam chip variabel responseBody untuk memilih dan merangkai fungsi GET_PROPERTY().
      • Guna menambahkan parameter input untuk GET_PROPERTY(), klik Variabel atau Nilai, lalu di Nilai, masukkan items.

        Fungsi ini akan mengekstrak properti dari payload JSON. Teruskan properti items sebagai parameter untuk fungsi ini. Tindakan ini akan menampilkan daftar HANYA nama produk, tanpa informasi produk lainnya. Fungsi Anda akan terlihat seperti berikut: 

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)
      • Jika perlu menghapus atau menghapus fungsi, klik simbol -.
    4. Klik kolom pertama di kolom Output untuk membuat variabel output baru guna menyimpan nilai data yang ditransformasi. Lengkapi kolom berikut:
      • Name: masukkan JSONList.
      • Jenis Data: JSON
      • Centang kotak Use as an output of integration.
      • Klik Create untuk membuat variabel dan menutup panel. Variabel JSONList baru akan muncul dalam daftar Variabel di sisi kiri editor Pemetaan Data.
    5. Tutup Data Mapping Editor setelah pemetaan selesai. Setiap perubahan akan disimpan otomatis.

Menambahkan dan mengonfigurasi tugas Kirim Email

Untuk mengonfigurasi tugas Kirim Email:

  1. Pilih Tasks di editor integrasi untuk menampilkan daftar tugas yang tersedia.
  2. Klik dan tempatkan elemen Send Email di editor integrasi.
  3. Tambahkan koneksi edge dari elemen Data Mapping ke elemen Send Email dengan mengarahkan kursor ke titik kontrol di elemen Data Mapping, lalu mengklik dan menarik garis ke titik kontrol pada elemen tugas Send Email. Tepi menunjukkan alur kontrol dari tugas Data Mapping ke tugas Send Email.
  4. Klik elemen Send Email pada desainer untuk membuka panel konfigurasi tugas. Tetapkan properti berikut:
    • Kepada Penerima: Masukkan alamat email Anda. Anda akan menggunakan email ini untuk mengonfirmasi bahwa integrasi berhasil diselesaikan.
    • Subject: Masukkan Email from Apigee Integration.
    • Body in Plain Text: Pilih variabel JSONList yang dibuat sebelumnya di tugas Data Mapping.
    • Opsi lainnya dapat dibiarkan dalam konfigurasi default.

    Perubahan pada properti disimpan secara otomatis.

Memverifikasi koneksi edge yang diperlukan

Pastikan Anda telah menambahkan koneksi edge antarelemen dalam integrasi Anda. Koneksi menunjukkan arah alur kontrol dari satu elemen (tugas atau pemicu) ke elemen lainnya. Untuk mengetahui informasi selengkapnya tentang edge, lihat Edge.

Koneksi yang telah selesai akan muncul seperti yang ditunjukkan dalam gambar di bawah ini:

gambar yang menampilkan alur panduan memulai gambar yang menampilkan alur panduan memulai

Menguji integrasi

Untuk menguji integrasi baru:

  1. Klik Test di toolbar editor integrasi.

    Dialog Test Integration akan muncul.

  2. Klik Uji integrasi.

Untuk informasi selengkapnya tentang pengujian, lihat Menguji dan memublikasikan integrasi.

Setelah berhasil diselesaikan, integrasi akan mengirimkan email yang berisi nilai JSON ke alamat email yang ditentukan dalam tugas Send Email. Konfirmasi penerimaan email di program email Anda.

Email yang dikirim oleh integrasi harus berisi isi yang mirip dengan berikut ini: 

[{
   "project": "en.wikipedia",
   "article": "Tree",
   "granularity": "monthly",
   "timestamp": "2020100100",
   "access": "desktop",
   "agent": "user",
   "views": 33828.0
}]

Selain memverifikasi konten email, Anda dapat memeriksa log untuk melihat status dan payload integrasi yang diberikan. Untuk melihat log:

  1. Klik Logs di toolbar editor integrasi.
  2. Di halaman Log Eksekusi, Anda dapat melihat detail setiap upaya untuk menjalankan integrasi. Setiap entri menyertakan detail upaya eksekusi, termasuk:
    • Nama integrasi
    • ID eksekusi
    • Status
    • Waktu mulai
    • Durasi
    • Versi Integrasi
    • ID Pemicu
  3. Klik panah peluas (>) di samping integrasi yang dijalankan untuk melihat daftar tugas dan variabel yang diperluas dalam integrasi, beserta status tugas dan payload variabel.