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

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 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-langkah 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 Koneksi.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh lebih dari 49 karakter.
    4. Jika perlu, masukkan Description untuk instance koneksi.
    5. Secara opsional, aktifkan Cloud logging, lalu pilih level log. Secara default, level log disetel ke Error.
    6. Akun Layanan: 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 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.

    8. Poin Maks Per Panggilan: Menentukan jumlah poin yang akan dikenakan untuk sebuah panggilan.
    9. Skema: Tentukan versi server Shopify yang akan dihubungkan.
    10. Use proxy: Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi dan mengonfigurasi 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:

    11. Jika perlu, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
    12. 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.

      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 lain, klik +TAMBAHKAN TUJUAN.

    2. Klik NEXT.
  6. Di bagian Authentication, tentukan detail Access Token.
  7. Klik NEXT.
  8. Peninjauan: Tinjau detail koneksi dan autentikasi Anda.
  9. Klik Buat.

Membuat token akses dan kredensial API

  1. Login ke akun Shopify.
  2. Di portal developer Shopify, klik Settings.
  3. Pilih Apps and sales channels > Kembangkan aplikasi.
  4. Klik Create an app.
  5. Dalam dialog yang muncul, masukkan nama aplikasi Anda, lalu klik Create.
  6. Di halaman Ringkasan, klik Konfigurasi cakupan Admin API, lalu pilih izin akses untuk aplikasi Anda.
  7. Klik Simpan.
  8. Pada halaman Credentials API, pilih Install app.
  9. Pada dialog yang muncul, klik Install.
  10. Di halaman Kredensial API, pilih Perlihatkan token sekali, lalu salin Token Akses Admin API untuk digunakan nanti saat Anda mengonfigurasi autentikasi untuk koneksi.
  11. Dari kolom API key dan API secret key, salin kunci untuk digunakan nanti saat Anda mengonfigurasi autentikasi untuk koneksi.

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.

  • 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:

    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.

Contoh operasi entity

Contoh - Menampilkan daftar semua produk

Contoh ini mencantumkan semua kumpulan data dalam entity Products.

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

Contoh - Mendapatkan detail pelanggan

Contoh ini mendapatkan detail pelanggan tertentu dari entity Customers.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih Customers dari daftar Entity.
  3. Pilih operasi Get, lalu klik Done.
  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 catatan pesanan

Contoh ini menghapus pesanan 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 Done.
  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 tertentu ke entity Customer.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih Customer dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  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"
}

    Dengan menjalankan contoh ini, Anda akan menampilkan respons yang serupa dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

    {
"Id": 6448083206296
}

Contoh - Membuat data di DiscountCode

Contoh ini membuat data baru dalam entity DiscountCode.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih DiscountCode dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload lalu masukkan nilai yang mirip dengan berikut ini di kolom Default Value: 
    {
"PriceRuleId": 1.394097291568E12,
"Code": "FREESHIP2025798"
}

    Dengan menjalankan contoh ini, Anda akan menampilkan respons yang serupa dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

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

Contoh - Membuat data di Pricerule

Contoh ini membuat data baru dalam entity Pricerule.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih Pricerule dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  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"
}

    Dengan menjalankan contoh ini, Anda akan menampilkan respons yang serupa dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

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

Contoh - Membuat data di ProductVariant

Contoh ini membuat data baru dalam entity ProductVariant.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih ProductVariant dari daftar Entity.
  3. Pilih operasi Create, lalu klik Selesai.
  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
}

    Dengan menjalankan contoh ini, Anda akan menampilkan respons yang serupa dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

    {
"Id": 42711984373912
}

Contoh - Memperbarui detail pelanggan

Contoh ini memperbarui detail pelanggan tertentu dalam entity Customer.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih Customer dari daftar Entity.
  3. Pilih operasi Update, lalu klik Selesai.
  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, daripada menentukan entityId, Anda juga dapat menetapkan filterClause ke 648400653532.

    Dengan menjalankan contoh ini, Anda akan menampilkan respons yang serupa dengan berikut ini dalam variabel output connectorOutputPayload tugas konektor Anda:

    {
"Id": 648400653532
}

Contoh - Memperbarui data di ProductVariant

Contoh ini memperbarui data dalam entity ProductVariant.

  1. Pada dialog Configure connector task, klik Entities.
  2. Pilih ProductVariant dari daftar Entity.
  3. Pilih operasi Update, lalu klik Selesai.
  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 entitas data yang akan diperbarui.

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

    Dengan menjalankan contoh ini, Anda akan menampilkan respons yang serupa 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_panggilan STRING Salah Menentukan jumlah poin yang akan digunakan untuk panggilan.
skema_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 RAHASIA 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 berikutnya