QuickBooks Online

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

Sebelum memulai

Sebelum menggunakan konektor QuickBooks Online, lakukan tugas berikut:

• Di project Google Cloud Anda:
  • Pastikan konektivitas jaringan 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 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 daftar 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 QuickBooks dari daftar drop-down Konektor yang tersedia.
   2. Versi Konektor: Pilih versi Konektor dari daftar 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. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
   6. 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.
   7. Company Id: Berikan ID perusahaan Aplikasi yang terdaftar di portal developer intuit.
   8. Secara opsional, masukkan Country Code: untuk edisi QuickBooks Online yang digunakan.
   9. Secara opsional, masukkan Minor Version: untuk digunakan saat mengirim permintaan ke QuickBooks Online API.
   10. Use Sandbox: Klik kotak centang jika Anda menggunakan akun Sandbox.
   11. (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 Manager Secret yang berisi 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.
   12. Secara opsional, klik + ADD 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. 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.

      Untuk memasukkan tujuan tambahan, klik +ADD DESTINATION.

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

   Jika otorisasi berhasil, status koneksi akan ditetapkan ke Active di halaman Connections.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

• Username and password
  • Nama pengguna: Nama pengguna untuk konektor
  • Password: Secret Manager Secret yang berisi sandi yang terkait dengan konektor.

Entitas, operasi, dan tindakan

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

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

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

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

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

  Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk mengetahui deskripsi mendetail tentang operasi, lihat operasi entitas tugas Connectors . 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 pertama yang disediakan untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, 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 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 entitas 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.

Batasan sistem

Konektor QuickBooks Online dapat memproses 1 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.

Contoh operasi entitas

Bagian ini menunjukkan cara melakukan beberapa operasi entitas di konektor ini.

Contoh - Mencantumkan semua Akun

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

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

Contoh - Mendapatkan data

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

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

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

Contoh - Membuat data

Contoh ini membuat data dalam entitas 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 tugas Connectors , klik connectorInputPayload, lalu masukkan nilai yang mirip dengan yang berikut 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": "[phone]",
       "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 nilai yang mirip dengan yang berikut:

   {
   { "Id": "64" }
   }

Contoh - Memperbarui data

Contoh ini memperbarui data dengan ID yang ditentukan dalam entitas 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 tugas Connectors, klik connectorInputPayload lalu masukkan nilai yang mirip dengan yang berikut di kolom Default Value:

   {
   {
   "PrivateNote": "Update"
   }
   }

5. Klik entityId, lalu masukkan 22 di kolom Default Value.

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

Contoh - Menghapus data

Contoh ini menghapus data dengan ID yang ditentukan dalam entitas 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 entitas Purchases.

   Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan yang berikut:

   {
   {Success}
   }

Menggunakan koneksi QuickBooks dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di 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.