WooCommerce

Gunakan konektor WooCommerce untuk melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan di WooCommerce.

Sebelum memulai

Sebelum menggunakan konektor WooCommerce, lakukan tugas berikut:

• Di project Google Cloud Anda:
  • Pastikan konektivitas jaringan telah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
  • Berikan peran IAM roles/connectors.admin kepada pengguna mengonfigurasi konektor.
  • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika Anda tidak memiliki akun layanan, Anda harus membuat akun layanan. Konektor dan akun layanan harus berada dalam project yang sama. Untuk mengetahui informasi selengkapnya, lihat Membuat akun layanan.

  • Aktifkan layanan berikut:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

  Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Mengonfigurasi konektor

Koneksi khusus untuk sumber data. Artinya, jika Anda memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan hal berikut:

1. Di konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.

   Buka halaman Koneksi

2. Klik + CREATE NEW untuk membuka halaman Create Connection.
3. Di bagian Location, pilih lokasi untuk koneksi.
   1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

   2. Klik NEXT.
4. Di bagian Connection Details, selesaikan langkah berikut:
   1. Konektor: Pilih WooCommerce dari menu drop-down Konektor yang tersedia.
   2. Versi konektor: Pilih Versi konektor dari menu drop-down versi yang tersedia.
   3. Di kolom Connection Name, masukkan nama untuk instance Koneksi.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
   4. Secara opsional, masukkan Description untuk instance koneksi.
   5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
   6. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
   7. Secara opsional, konfigurasikan Connection node settings:
      • Minimum number of nodes: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Diperlukan lebih banyak node untuk memproses lebih banyak transaksi untuk koneksi dan sebaliknya, diperlukan lebih sedikit node untuk memproses lebih sedikit transaksi. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

   Catatan: Anda hanya dapat menyesuaikan nilai node koneksi jika Anda adalah pelanggan dengan model pembayaran sesuai penggunaan.
   8. (Opsional) Di bagian Advanced settings, centang kotak Use proxy untuk mengonfigurasi server proxy untuk koneksi dan mengonfigurasi nilai berikut:
   • Skema Autentikasi Proxy: Pilih jenis autentikasi untuk melakukan autentikasi dengan server proxy. Jenis autentikasi berikut didukung:
     • Basic: Autentikasi HTTP dasar.
     • Digest: Autentikasi HTTP ringkas.
   • Proxy User: Nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
   • Proxy Password: Secret Secret Manager dari sandi pengguna.
   • Jenis SSL Proxy: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Jenis autentikasi berikut didukung:
     • Auto: Setelan default. Jika URL adalah URL HTTPS, opsi Tunnel akan digunakan. Jika URL adalah URL HTTP, opsi NEVER akan digunakan.
     • Always: Koneksi selalu mengaktifkan SSL.
     • Never: Koneksi tidak mengaktifkan SSL.
     • Tunnel: Koneksi melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir bolak-balik melalui proxy.
   • Di bagian Proxy Server, masukkan detail server proxy.
     1. Klik + Add destination.
     2. Pilih Destination Type.
        • Alamat host: Tentukan nama host atau alamat IP tujuan.

          Jika Anda ingin membuat koneksi pribadi ke sistem backend, lakukan hal berikut:

          • Buat lampiran layanan PSC.
          • Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Host address.
   9. Secara opsional, klik + ADD LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
   10. Klik NEXT.
5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
   1. Destination Type: Pilih Destination Type.
      • Untuk menentukan nama host atau alamat IP tujuan, pilih Host address dan masukkan alamat di kolom host 1.
      • Untuk membuat koneksi pribadi, pilih Endpoint attachment. Di daftar Endpoint Attachment, pilih lampiran endpoint yang dibuat untuk sistem backend Anda.
      Catatan: Untuk mempelajari cara membuat lampiran endpoint, lihat Konektivitas jaringan pribadi. Setelah dibuat, lampiran endpoint akan terlihat di daftar Endpoint Attachment.

      Jika Anda ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.

   2. Klik NEXT.
6. Di bagian Authentication, masukkan detail autentikasi.

   Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

7. Setelah menentukan detail autentikasi, klik NEXT.
8. Review: Tinjau detail koneksi dan autentikasi Anda.
9. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail autentikasi.

• Kunci Konsumen: Kunci konsumen yang ditetapkan oleh WooCommerce saat membuat kredensial autentikasi.
• Consumer Secret: Secret Secret Manager yang berisi secret konsumen yang terkait dengan konektor.

Batasan sistem

Konektor Woocommerce dapat memproses 2 transaksi per detik, per node, dan membatasi transaksi apa pun yang melebihi batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Integration Connectors, lihat Batas.

Catatan: Jumlah node Integration Connectors akan otomatis diskalakan secara dinamis berdasarkan penggunaan Anda. Namun, jika Anda ingin mencadangkan kapasitas untuk volume besar tanpa menunggu penskalaan otomatis, Anda dapat menyesuaikan nilai node minimum untuk koneksi. Diperlukan lebih banyak node untuk memproses lebih banyak transaksi untuk koneksi. Sebaliknya, diperlukan lebih sedikit node jika koneksi memproses lebih sedikit transaksi. Untuk mengonfigurasi nilai node, lakukan hal berikut:

• Jika Anda adalah pelanggan dengan model pembayaran sesuai penggunaan, konfigurasikan nilai node minimum dan maksimum di halaman edit koneksi.
• Jika Anda adalah pelanggan berbasis langganan, hubungi dukungan.

Jumlah maksimum transaksi yang dapat ditangani node bergantung pada berbagai faktor. Jadi, sebelum menyesuaikan node minimum untuk mendapatkan throughput yang lebih baik, sebaiknya periksa apakah sistem backend Anda telah disiapkan secara optimal untuk menangani traffic yang diperlukan.

Menggunakan koneksi WooCommerce dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di kedua Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Connectors.

• Untuk memahami cara membuat dan menggunakan tugas Connectors di Apigee Integration, lihat Tugas Connectors.
• Untuk memahami cara membuat dan menggunakan tugas Connectors di Application Integration, lihat Tugas Connectors.

Entity, operasi, dan tindakan

Semua Integration Connectors menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ini ditampilkan kepada Anda sebagai entity, operasi, dan tindakan.

Catatan: Anda dapat melihat entity, operasi, dan tindakan konektor di tugas Connectors.

• Entitas: Entitas dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entity berbeda-beda dari satu konektor ke konektor lainnya. Misalnya, di konektor database, tabel adalah entity, di konektor server file, folder adalah entity, dan di konektor sistem pesan, antrean adalah entity.

  Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga daftar Entities akan kosong.

• Operation: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entity:
  • Daftar
  • Dapatkan
  • Buat
  • Update
  • Hapus

  Memilih entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk mengetahui deskripsi mendetail tentang operasi, lihat operasi entity tugas Connectors . Namun, jika konektor tidak mendukung operasi entity apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar Operations.

• Tindakan: Tindakan adalah fungsi kelas pertama yang disediakan untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entity, dan berbeda-beda dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output parameter. Namun, ada kemungkinan konektor tidak mendukung tindakan apa pun, sehingga daftar Actions akan kosong.

Catatan: Semua entity dan tindakan akan memiliki skema yang terkait dengannya. Misalnya, skema tindakan akan memiliki detail parameter seperti; nama parameter, dan jenis data yang sesuai. Skema (metadata) untuk entity dan tindakan diambil oleh koneksi saat runtime dari backend Anda. Jika ada pembaruan pada skema, pembaruan tersebut tidak akan otomatis ditampilkan di koneksi yang ada; Anda harus memperbarui skema secara manual. Untuk memperbarui skema koneksi, buka halaman Connection details koneksi, lalu klik Refresh connection schema.

Tindakan

Bagian ini mencantumkan tindakan yang didukung oleh konektor. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Catatan: Hasil semua tindakan akan tersedia sebagai respons JSON di parameter respons connectorOutputPayload tugas Connectors setelah Anda menjalankan integrasi.

Tindakan Update Shipping Zone Locations

Tindakan ini memungkinkan Anda Memperbarui lokasi untuk zona pengiriman di Woocommerce.

Parameter input tindakan Update Shipping Zone Locations

Nama parameter	Jenis data	Wajib	Deskripsi
ZoneId	String	Ya	ID zona yang akan diperbarui.
Locations	String	Ya	Detail lokasi.

Untuk mengetahui contoh cara mengonfigurasi tindakan Update Shipping Zone Locations, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Memperbarui Lokasi Zona Pengiriman

Contoh ini Memperbarui lokasi untuk zona pengiriman.

1. Di dialog Configure connector task, klik Actions.
2. Pilih tindakan Update Shipping Zone Locations, lalu klik Done.
3. Di bagian Task Input tugas Connectors , klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "ZoneId": "7",
       "Locations": "[{\"code\":\"BR:SP\",\"type\":\"state\"}]"
     }

Jika tindakan berhasil, parameter respons akan memiliki nilai yang mirip dengan berikut:Update Shipping Zone LocationsconnectorOutputPayload

[ { "code": "BR:SP", "type": "state",
    "_links_collection_href": "https://your-website.com/wp-json/wc/v3/shipping/zones/7/locations", 
    "_links_describes_href": "https://your-website.com/wp-json/wc/v3/shipping/zones/7", 
    "success": "true" } ]

Contoh operasi entity

Contoh - Mencantumkan data entity

Contoh ini mencantumkan data entity Orders.

1. Di dialog Configure connector task, klik Entities.
2. Pilih Orders dari daftar Entity.
3. Pilih operasi List, lalu klik Done.
4. Di bagian Task Input tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan.

   Misalnya, menetapkan klausa filter ke Id='891', hanya akan mencantumkan data yang ID pesanannya adalah 891.

Contoh - Mendapatkan satu data dari entity

Contoh ini mengambil data dari entity Orders.

1. Di dialog Configure connector task, klik Entities.
2. Pilih Orders dari daftar Entity.
3. Pilih operasi Get, lalu klik Done.
4. Di bagian Task Input tugas Connectors , klik entityId, lalu masukkan 891 di kolom Default Value.

   Di sini, 891 adalah ID unik untuk entity resource Orders.

Contoh - Menghapus data dari entity

Contoh ini menghapus data dari entity Orders.

1. Di dialog Configure connector task, klik Entities.
2. Pilih Orders dari daftar Entity.
3. Pilih operasi Delete, lalu klik Done.
4. Di bagian Task Input tugas Connectors , klik entityId, lalu masukkan 891 di kolom Default Value.

   Atau, jika entity memiliki kunci utama gabungan, bukan menentukan entityId, Anda dapat menetapkan filterClause. Misalnya, Id='891'.

Contoh - Membuat data di entity

Contoh ini membuat data di entity Orders.

1. Di dialog Configure connector task, klik Entities.
2. Pilih Orders dari daftar Entity.
3. Pilih operasi Create, lalu klik Done.
4. Di bagian Task Input tugas Connectors , klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "BillingFirstName": "Alex",
   "BillingLastName": "Smith",
   "Status":"processing",
   "CustomerId": 1,
   "ShippingAddress1":"809/2 Downtown, Alaska, United States"
   }

Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor akan memiliki respons operasi pembuatan.

{ 
"Id": 1010 
}

Contoh - Memperbarui data di entity

Contoh ini memperbarui data di entity Orders.

1. Di dialog Configure connector task, klik Entities.
2. Pilih Orders dari daftar Entity.
3. Pilih operasi Update, lalu klik Done.
4. Di bagian Task Input tugas Connectors , klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
   "Status": "on-hold"
   }

5. Di bagian Task Input tugas Connectors , klik entityId, lalu masukkan 1010 di kolom Default Value.

Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor akan memiliki respons operasi pembaruan.

{
"Id": 1010
}