Shopify

Konektor Shopify memungkinkan Anda melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan di Shopify.

Versi yang didukung

Konektor ini membuat model Shopify Admin API sebagai database relasional.

Sebelum memulai

Sebelum menggunakan konektor Shopify, lakukan tugas berikut:

• Di project Google Cloud Anda:
  • Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
  • Berikan peran IAM roles/connectors.admin kepada pengguna yang 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 tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk 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

Untuk mengonfigurasi konektor, Anda harus membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:

1. Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, 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 tindakan berikut:
   1. Konektor: Pilih Shopify 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 Connection.

      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. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
   7. Secara opsional, konfigurasikan Setelan node koneksi:
      • Jumlah node minimum: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Semakin banyak node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi, dan sebaliknya, semakin sedikit node yang diperlukan untuk memproses lebih sedikit transaksi. Untuk memahami pengaruh node terhadap harga konektor, 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 merupakan pelanggan Bayar sesuai penggunaan.
   8. ID Aplikasi: AppId untuk admin API.
   9. Max Points Per Call: Menentukan jumlah poin yang akan dikenakan biaya untuk panggilan.
   10. Skema: Tentukan versi server Shopify yang akan dihubungkan.
   11. Gunakan proxy: Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi dan konfigurasi nilai berikut:
   • Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
     • Dasar: Autentikasi HTTP dasar.
     • Digest: Ringkasan autentikasi HTTP.
   • Pengguna Proxy: Nama pengguna yang akan digunakan untuk mengautentikasi dengan server proxy.
   • Sandi Proxy: Secret Secret Manager dari sandi pengguna.
   • Proxy SSL Type: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Jenis autentikasi berikut didukung:
     • Otomatis: Setelan default. Jika URL adalah URL HTTPS, opsi Tunnel akan digunakan. Jika URL adalah URL HTTP, opsi NEVER akan digunakan.
     • Selalu: Koneksi selalu mengaktifkan SSL.
     • Tidak pernah: Koneksi tidak mengaktifkan SSL.
     • Tunnel: Koneksi dilakukan melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir bolak-balik melalui proxy.
   • Di bagian Server Proxy, masukkan detail server proxy.
     1. Klik + Tambahkan tujuan.
     2. Pilih Jenis Tujuan.
        • Alamat host: Tentukan nama host atau alamat IP tujuan.

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

          • Buat lampiran layanan PSC.
          • Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
   12. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
   13. Klik NEXT.
5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
   1. Jenis Tujuan: Pilih Jenis Tujuan.
      • Pilih Host address dari daftar untuk menentukan nama host atau alamat IP tujuan.
      • Jika Anda ingin membuat koneksi pribadi ke sistem backend, pilih Endpoint attachment dari daftar, lalu pilih lampiran endpoint yang diperlukan dari daftar Endpoint Attachment.
        Catatan: Untuk memahami cara membuat lampiran endpoint, lihat lampiran layanan PSC dan lampiran endpoint. Setelah Anda membuat lampiran endpoint, lampiran tersebut akan terlihat dalam daftar Lampiran Endpoint.

      Jika 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.

      Untuk memasukkan tujuan tambahan, klik +TAMBAHKAN TUJUAN.

   2. Klik NEXT.
6. Di bagian Authentication, masukkan detail autentikasi.
   1. Koneksi Shopify tidak memerlukan autentikasi apa pun.
   2. Klik NEXT.
7. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
8. Klik Create.

Entity, operasi, dan tindakan

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

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

• Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, dalam konektor database, tabel adalah entitas, dalam konektor server file, folder adalah entitas, dan dalam konektor sistem pesan, antrean adalah entitas.

  Namun, mungkin konektor tidak mendukung atau memiliki entity apa pun, dalam hal ini, daftar Entities akan kosong.

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

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

• Tindakan: Tindakan adalah fungsi kelas satu yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan bervariasi dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, konektor mungkin tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Catatan: Semua entitas 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 memuat ulang skema secara manual. Untuk memuat ulang skema koneksi, buka halaman Connection details koneksi, lalu klik Refresh connection schema.

Contoh operasi entity

Contoh - Mencantumkan semua produk

Contoh ini mencantumkan semua data dalam entitas Products.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Products dari daftar Entity.
3. Pilih operasi List, lalu klik Selesai.

Contoh - Mendapatkan detail pelanggan

Contoh ini mendapatkan detail pelanggan yang ditentukan dari entity Customers.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Customers dari daftar Entity.
3. Pilih operasi Get, lalu klik Selesai.
4. Masukkan ID entitas pelanggan yang detailnya ingin Anda ambil.

   Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 365009521884E12 di kolom Default Value.

Contoh - Menghapus data pesanan

Contoh ini menghapus urutan yang ditentukan dari entity Order.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Order dari daftar Entity.
3. Pilih operasi Delete, lalu klik Selesai.
4. Masukkan ID entitas pesanan yang ingin Anda hapus.

   Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 475009571483E15 di kolom Default Value.

Contoh - Menambahkan pelanggan

Contoh ini menambahkan pelanggan yang ditentukan ke entitas Customer.

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

   {
   "FirstName": "Test",
   "LastName": "Customer5"
   }

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

   {
   "Id": 6448083206296
   }

Contoh - Membuat kumpulan data di DiscountCode

Contoh ini membuat data baru di entitas DiscountCode.

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

   {
   "PriceRuleId": 1.394097291568E12,
   "Code": "FREESHIP2025798"
   }

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini di variabel output connectorOutputPayload tugas konektor Anda:

   {
   "Id": 1.97836790828E13,
   "PriceRuleId": null
   }

Contoh - Membuat data di Pricerule

Contoh ini membuat data baru di entitas Pricerule.

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

   {
   "Id": 7.13459564696E11,
   "AllocationMethod": "each",
   "CustomerSelection": "all",
   "TargetType": "line_item",
   "UsageLimit": 100.0,
   "Title": "DP_PriceRule"
   }

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

   {
   "Id": 197836790834,
   "PriceRuleId": null
   }

Contoh - Membuat kumpulan data di ProductVariant

Contoh ini membuat data baru di entitas ProductVariant.

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

   {
   "Id": 1070325065,
   "ProductId": 7652181016728,
   "ImageId": null,
   "Price": 1,
   "CompareAtPrice": null,
   "Title": "Yellow",
   "Barcode": null,
   "FulfillmentService": "manual",
   "InventoryManagement": "shopify",
   "InventoryPolicy": "deny",
   "InventoryQuantity": 1070325069,
   "Option1": "Yellow",
   "Option2": null,
   "Option3": null,
   "Position": 5,
   "Sku": "",
   "Taxable": true
   }

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

   {
   "Id": 42711984373912
   }

Contoh - Memperbarui detail pelanggan

Contoh ini memperbarui detail pelanggan yang ditentukan di entitas Customer.

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

   {
   "FirstName": "Test",
   "LastName": "Customer2"
   }

5. Masukkan ID entitas pelanggan yang ingin Anda hapus.

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

   Atau, alih-alih menentukan entityId, Anda juga dapat menetapkan filterClause ke 648400653532.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

   {
   "Id": 648400653532
   }

Contoh - Memperbarui data di ProductVariant

Contoh ini memperbarui data di entity ProductVariant.

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

   {
   "ProductId": 7.652181016728E12,
   "ImageId": null,
   "Price": 200.0,
   "CompareAtPrice": null,
   "Title": "Yellow Updated",
   "Barcode": null,
   "FulfillmentService": "manual",
   "InventoryManagement": "shopify",
   "InventoryQuantity": 1.070325069E9,
   "Option1": "Yellow new",
   "Option2": null,
   "Option3": null,
   "Position": 5.0,
   "Sku": "",
   "Taxable": true
   }

5. Tentukan ID entity data yang akan diperbarui.

   Untuk menetapkan ID entity, klik entityId, lalu masukkan 34601602744472 di kolom Default Value.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

   {
   "Id": 2484258073471
   }

Menggunakan terraform untuk membuat koneksi

Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.

Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:

Nama parameter	Jenis data	Wajib	Deskripsi
max_points_per_call	STRING	Salah	Menentukan jumlah poin yang akan dikenakan untuk panggilan.
schema_v23	ENUM	Salah	Tentukan versi server Shopify yang akan dihubungkan. Nilai yang didukung adalah: REST-2023-04, REST-2023-07, GRAPHQL-2023-04, GRAPHQL-2023-07
proxy_enabled	BOOLEAN	Salah	Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi.
proxy_auth_scheme	ENUM	Salah	Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE
proxy_user	STRING	Salah	Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
proxy_password	SECRET	Salah	Sandi yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer.
proxy_ssltype	ENUM	Salah	Jenis SSL yang akan digunakan saat terhubung ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, TUNNEL

Menggunakan koneksi Shopify dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

• Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
• Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.

Langkah selanjutnya

• Pahami cara menangguhkan dan melanjutkan koneksi.
• Pahami cara memantau penggunaan konektor.
• Pahami cara melihat log konektor.