QuickBooks Online

Konektor QuickBooks Online memungkinkan Anda melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan di database QuickBooks.

Sebelum memulai

Sebelum menggunakan konektor QuickBooks Online, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • Memberikan 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 yang perlu mengautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk selengkapnya informasi, lihat Membuat akun layanan.

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

      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

Mengonfigurasi konektor mengharuskan Anda membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Ini berarti bahwa jika Anda 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 Integration Connectors > Halaman Koneksi lalu pilih atau buat project Google Cloud.

    Buka halaman Koneksi

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

      Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

    2. Klik NEXT.
  4. Di bagian Connection Details, selesaikan langkah-langkah berikut:
    1. Konektor: Pilih QuickBooks 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 huruf kecil.
      • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh lebih dari 63 karakter.
    4. Jika perlu, masukkan Description untuk instance koneksi.
    5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    6. Anda juga dapat mengonfigurasi Setelan node koneksi:

      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah maksimum node: Masukkan jumlah maksimum node koneksi.

      Simpul adalah unit (atau replika) koneksi yang memproses transaksi. Diperlukan lebih banyak {i>node<i} untuk memproses lebih banyak transaksi untuk koneksi dan sebaliknya, lebih 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.

    7. ID Perusahaan: Berikan ID perusahaan dari Aplikasi yang terdaftar di portal developer intuit.
    8. Jika perlu, masukkan Kode Negara: untuk edisi QuickBooks Online yang digunakan.
    9. Jika perlu, masukkan Versi Minor: untuk digunakan saat mengirim permintaan ke QuickBooks Online API.
    10. Use Sandbox: Klik kotak centang jika Anda menggunakan akun Sandbox.
    11. Gunakan proxy: Centang kotak ini 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 ini didukung:
        • Dasar: Autentikasi HTTP dasar.
        • Digest: Autentikasi HTTP ringkasan.
      • Pengguna Proxy: Nama pengguna yang akan digunakan untuk mengautentikasi dengan server proxy.
      • Sandi Proxy: Rahasia Secret manager sandi pengguna.
      • Jenis SSL Proxy: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Jenis autentikasi berikut ini didukung:
        • Otomatis: Setelan default. Jika URL-nya adalah URL HTTPS, opsi Tunnel akan digunakan. Jika URL adalah URL HTTP, opsi TIDAK PERNAH akan digunakan.
        • Selalu: Koneksi selalu mengaktifkan SSL.
        • Tidak pernah: 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 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 hal berikut:

    12. Anda juga dapat mengklik + 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 Anda, pilih Endpoint attachment dari daftar, lalu pilih lampiran endpoint yang diperlukan dari daftar Endpoint Lampiran.

      Jika Anda ingin membuat koneksi publik ke sistem {i> backend<i} dengan keamanan tambahan, Anda dapat pertimbangkan untuk mengonfigurasi jaringan keluar statis alamat IP untuk koneksi Anda, lalu konfigurasikan aturan firewall untuk hanya mengizinkan alamat IP statis tertentu ke daftar yang diizinkan.

      Untuk memasukkan tujuan lain, klik +TAMBAHKAN TUJUAN.

    2. Klik NEXT.
  6. Di bagian Authentication, masukkan detail autentikasi.
    • Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
      1. Client ID: Client ID yang digunakan untuk meminta token akses.
      2. Cakupan: Daftar cakupan yang diinginkan yang dipisahkan koma
      3. Rahasia Klien: Rahasia Secret Manager yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
      4. Version: Pilih versi dari menu dropdown dan Berikan akses.
      5. Klik Berikutnya.
  7. Peninjauan: Tinjau detail koneksi dan autentikasi Anda.
  8. Klik Create.
  9. Klik Otorisasi.

    Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

  • Nama pengguna dan sandi
    • Nama pengguna: Nama pengguna untuk konektor
    • Sandi: Rahasia Secret Manager yang berisi sandi yang terkait dengan konektor.

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 diekspos kepada Anda sebagai entity, operasi, dan tindakan.

  • Entitas: Entitas dapat dianggap sebagai objek, atau kumpulan properti, di aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke entitas konektor 20%. Misalnya, dalam konektor {i>database<i}, tabel adalah entitas, dalam konektor server file, folder adalah entitas, dan dalam konektor sistem pesan, antrean adalah entitas.

    Namun, mungkin saja konektor tidak mendukung atau memiliki entitas apa pun. Dalam hal ini, Daftar Entities akan kosong.

  • Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entitas. Anda dapat melakukan salah satu operasi berikut pada entitas:

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

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

Keterbatasan sistem

Konektor QuickBooks Online dapat memproses 1 transaksi per detik, per node, dan men-throttle semua transaksi di luar batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk sebuah koneksi.

Untuk informasi tentang batas yang berlaku bagi Konektor Integrasi, lihat Batas.

Contoh operasi entity

Bagian ini menunjukkan cara melakukan beberapa operasi entity dalam konektor ini.

Contoh - Mencantumkan semua Akun

Contoh ini mencantumkan semua entitas associated with the Current application of QB Online Akun.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Accounts dari daftar Entity.
  3. Pilih operasi List, lalu klik Selesai.
  4. Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat filter kumpulan hasil dengan menentukan klausa filter. Menentukan nilai klausa filter selalu berada dalam tanda kutip tunggal ('). Misalnya, BillId='25'. Anda juga dapat menentukan beberapa kondisi filter dengan menggunakan operator logika. Sebagai contoh, BillId='25' and Active=false

Contoh - Mendapatkan data

Contoh ini mendapatkan data dengan ID yang ditentukan dari entity Bills.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Bills dari daftar Entity.
  3. Pilih operasi Get, lalu klik Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu lalu masukkan 220 di kolom Nilai Default.

    Di sini, 220 adalah nilai kunci utama dalam entity Bills.

Contoh - Membuat data

Contoh ini membuat data dalam entity Vendors.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Vendors 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 ini di Kolom Default Value:
    {
    {
      {
        "Id": "32",
        "SyncToken": "0",
        "MetaData_CreateTime": "2024-04-17 17:13:24.0",
        "MetaData_LastUpdatedTime": "2024-04-24 19:55:23.0",
        "Title": null,
        "GivenName": null,
        "MiddleName": null,
        "FamilyName": null,
        "Suffix": null,
        "DisplayName": "tim Telephone",
        "CompanyName": "tim Telephone",
        "PrintOnCheckName": "tim Telephone",
        "Active": true,
        "PrimaryPhone_FreeFormNumber": "(650) 555-1616",
        "AlternatePhone_FreeFormNumber": null,
        "Mobile_FreeFormNumber": null,
        "Fax_FreeFormNumber": null,
        "PrimaryEmailAddr_Address": null,
        "WebAddr_URI": null,
        "BillAddr_Id": "33",
        "BillAddr_Line1": "10 Main St.",
        "BillAddr_Line2": null,
        "BillAddr_Line3": null,
        "BillAddr_Line4": null,
        "BillAddr_Line5": null,
        "BillAddr_City": "Palo Alto",
        "BillAddr_Country": null,
        "BillAddr_CountrySubDivisionCode": "CA",
        "BillAddr_PostalCode": "94303",
        "BillAddr_Lat": "37.445013",
        "BillAddr_Long": "-122.1391443",
        "OtherContactInfo_Type": null,
        "OtherContactInfo_Telephone_FreeFormNumber": null,
        "TaxIdentifier": null,
        "TermRef": "1",
        "TermRef_Name": null,
        "Balance": "0",
        "AcctNum": null,
        "Vendor1099": false,
        "CurrencyRef": "USD",
        "CurrencyRef_Name": "United States Dollar"
      }
    }

    Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki serupa dengan berikut ini:

    {
    { "Id": "64" }
    }

Contoh - Memperbarui data

Contoh ini memperbarui data dengan ID yang ditentukan dalam entity Purchases.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Teams 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 ini di Kolom Default Value:
    {
    {
    "PrivateNote": "Update"
    }
    }
  5. Klik entityId, lalu masukkan 22 di kolom Default Value.

    Di sini, 22 adalah nilai kunci utama dalam entity Purchases.

Contoh - Menghapus data

Contoh ini menghapus data dengan ID yang ditentukan dalam entity Invoices.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Invoices dari daftar Entity.
  3. Pilih operasi Delete, lalu klik Done.
  4. Klik entityId, lalu masukkan 10 di kolom Default Value.

    Di sini, 10 adalah nilai kunci utama dalam entity Purchases.

    Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki serupa dengan berikut ini:

    {
    {Success}
    }

Menggunakan koneksi QuickBooks dalam integrasi

Setelah dibuat, koneksi akan tersedia di Integrasi Apigee dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Connectors.

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