Integrasi Apigee dengan pemicu API

Panduan memulai ini menunjukkan cara membuat contoh integrasi di Integrasi Apigee. Langkah-langkah berikut menjelaskan cara untuk mengonfigurasi pemicu, tugas, edge, 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 menjadi format yang dapat digunakan, dan mengirim daftar hasilnya dalam email, semuanya dari dalam desainer integrasi.

Membuat integrasi baru

Untuk membuat integrasi baru, lakukan langkah-langkah berikut:

  1. Di UI Apigee, pilih Organisasi Apigee Anda.
  2. Klik Develop > Integrasi.
  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

{i>Trigger<i} diperlukan untuk memulai urutan tugas yang membentuk integrasi. Semua 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 API trigger di editor integrasi.
  3. Klik elemen API trigger pada desainer untuk membuka pemicu panel konfigurasi.
  4. Integrasi Apigee secara otomatis mengisi Label pemicu, Nama pemicu, dan ID Pemicu. ID Pemicu dihasilkan oleh 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 dijalankan 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 Memanggil REST Endpoint, Pemetaan Data, dan Kirim Email. Konfigurasi detail untuk setiap tugas dijelaskan dalam langkah-langkah di bawah ini.

Mengonfigurasi tugas REST Endpoint Panggilan

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 Memanggil elemen REST Endpoint dengan mengarahkan kursor ke titik kontrol pada elemen API trigger, lalu mengklik dan menarik garis ke titik kontrol pada elemen tugas Call REST Endpoint. Edge menunjukkan alur kontrol dari pemicu API ke tugas Call REST Endpoint.

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

  4. Klik elemen Call REST Endpoint pada desainer untuk membuka tugas panel konfigurasi. Tetapkan properti berikut:
    • Label: Masukkan nama khusus untuk tugas ini. Misalnya, masukkan Call REST Endpoint Task.
    • Autentikasi: Untuk panduan memulai ini, profil autentikasi tidak diperlukan. Untuk informasi lebih lanjut tentang penggunaan profil autentikasi bagi kasus penggunaan lainnya, lihat Buat 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 tayangan halaman untuk artikel bernama Tree untuk bulan tertentu.
      • Metode HTTP: Pilih GET menggunakan daftar dropdown.
    • Output Tugas: Di sini Integrasi Apigee mengisi tiga variabel untuk menyimpan output data respons panggilan endpoint REST:
      • responseHeader(Memanggil REST Endpoint): Variabel ini menyimpan header respons data yang terkait dengan tugas Call REST Endpoint. Data variabel adalah jenis String (STR).
      • responseBody(Call REST Endpoint): Variabel ini menyimpan isi respons data yang terkait dengan tugas Call REST Endpoint. Data variabel adalah jenis String (STR).
      • responseStatus(Call REST Endpoint): Variabel ini menyimpan status respons data 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, gunakan nilai default untuk setiap variabel ini.
    • Kolom yang tersisa harus berisi nilai default berikut:
      • Ikuti pengalihan: True
      • Tugas akan gagal saat 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 Pemetaan Data di editor integrasi.
  3. Tambahkan koneksi edge dari elemen Call REST Endpoint ke Elemen Pemetaan Data dengan mengarahkan kursor ke titik kontrol pada 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 Pemetaan Data.
  4. Klik tugas Data Mapping pada desainer untuk membuka panel konfigurasi menyelesaikan tugas tersebut.
  5. Klik Open Data Mapping Editor.

    Editor Pemetaan Data memungkinkan Anda memetakan variabel input ke variabel output yang diinginkan, menggunakan fungsi transformasi yang tersedia. Output-nya kemudian tersedia sebagai variabel untuk tugas atau pemicu integrasi lainnya. Untuk mengetahui 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 masukan:

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

      Dalam hal ini, Anda dapat mengonversi payload ke JSON dan kemudian mengulangi rangkaian respons untuk mendapatkan daftar nama produk yang diperlukan untuk notifikasi email.

      • Pilih TO_JSON() untuk mengonversi string responseBody menjadi JSON.
      • Klik + (Tambahkan fungsi) di chip variabel responseBody untuk memilih dan rantai 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. Ini akan mengembalikan daftar HANYA nama produk, tanpa informasi produk lainnya. Fungsi Anda akan terlihat seperti berikut: 

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)
      • Jika Anda perlu menghapus fungsi, klik simbol -.
    4. Klik kolom pertama di kolom Output untuk membuat variabel output baru guna menyimpan nilai transformasi layanan otomatis dan data skalabel. 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 di kolom Variables di sebelah kiri editor Pemetaan Data.
    5. Tutup Editor Pemetaan Data setelah pemetaan selesai. Setiap perubahan akan disimpan secara 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 Pemetaan Data 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 Pemetaan Data ke tugas Send Email.
  4. Klik elemen Send Email pada desainer untuk membuka panel konfigurasi dari tugas. Tetapkan properti berikut:
    • Kepada Penerima: Masukkan alamat email Anda. Anda akan menggunakan email ini untuk mengonfirmasi menyelesaikan integrasi dengan sukses.
    • Subject: Masukkan Email from Apigee Integration.
    • Isi dalam Teks Biasa: Pilih variabel JSONList yang dibuat sebelumnya di tugas Pemetaan Data.
    • Opsi yang tersisa 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. Koneksi menunjukkan arah alur kontrol dari satu elemen (tugas atau pemicu) ke elemen lainnya. Untuk mengetahui informasi selengkapnya tentang tepi, lihat Edge.

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

gambar yang menunjukkan alur panduan memulai gambar yang menunjukkan alur panduan memulai

Menguji integrasi

Untuk menguji integrasi baru:

  1. Klik Test di toolbar editor integrasi.

    Panel Test Integration akan muncul.

  2. Klik Uji integrasi.

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

Setelah berhasil diselesaikan, integrasi akan mengirimkan email 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 serupa 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 statusnya dan payload dari integrasi tertentu. Untuk melihat log:

  1. Klik Logs di toolbar editor integrasi.
  2. Di halaman Execution Logs, Anda dapat melihat detail tentang 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 luaskan (&gt;) di samping integrasi yang dijalankan untuk melihat daftar tugas dan variabel dalam integrasi, bersama dengan status tugas dan {i>payload<i} variabel.