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 telah 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 Anda tidak memiliki akun layanan, Anda harus membuat akun layanan. 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 + BUAT BARU untuk membuka halaman Buat Koneksi.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Wilayah: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik NEXT.
  4. Di bagian Detail Koneksi, selesaikan langkah-langkah berikut:
    1. Konektor: Pilih QuickBooks dari menu 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 Deskripsi untuk instance koneksi.
    5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    6. Jika perlu, konfigurasikan Setelan node koneksi:

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

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan untuk memproses lebih banyak transaksi untuk suatu koneksi akan bertambah dan sebaliknya, jumlah node yang diperlukan untuk memproses lebih sedikit transaksi akan berkurang. 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.

    7. ID Perusahaan: Berikan ID perusahaan Aplikasi yang terdaftar di portal developer Intuit.
    8. Secara opsional, masukkan Kode Negara: untuk edisi QuickBooks Online yang digunakan.
    9. Secara opsional, masukkan Versi Minor: untuk digunakan saat mengirim permintaan ke QuickBooks Online API.
    10. Gunakan Sandbox: Klik kotak centang jika Anda menggunakan akun Sandbox.
    11. (Opsional) Di bagian Setelan lanjutan, centang kotak Gunakan proxy 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: Autentikasi HTTP Digest.
      • Pengguna Proxy: Nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
      • Sandi Proxy: Secret Manager secret dari sandi pengguna.
      • Jenis SSL Proxy: 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 JANGAN PERNAH akan digunakan.
        • Selalu: Koneksi selalu diaktifkan SSL.
        • Tidak Pernah: Koneksi tidak diaktifkan untuk SSL.
        • Tunnel: Koneksi dilakukan melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir dua arah 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:

    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.
      • Untuk menentukan nama host atau alamat IP tujuan, pilih Alamat host dan masukkan alamat di kolom Host 1.
      • Untuk membuat koneksi pribadi, pilih Endpoint attachment dan pilih lampiran yang diperlukan dari daftar Endpoint Attachment.

      Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan mengonfigurasi alamat IP keluar statis untuk koneksi Anda, 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.
    • Pilih Jenis autentikasi dan masukkan detail yang relevan.
      1. Client ID: Client ID yang digunakan untuk meminta token akses.
      2. Cakupan: Daftar cakupan yang diinginkan, dipisahkan koma
      3. Rahasia Klien: Secret Manager Secret yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
      4. Versi: Pilih versi dari menu dropdown dan Beri akses.
      5. Klik Berikutnya.
  7. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  8. Klik Buat.
  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: Secret Manager Secret yang berisi sandi yang terkait dengan konektor.

Entitas, operasi, dan tindakan

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

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

    Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity apa pun, sehingga 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 entitas tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak tercantum dalam daftar Operations.

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

Batasan sistem

Konektor QuickBooks Online dapat memproses 1 transaksi per detik, per node, dan membatasi transaksi apa pun di luar 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.

Contoh operasi entity

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

Contoh - Mencantumkan semua Akun

Contoh ini mencantumkan semua entitas Accountsassociated 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 Selesai.
  4. Secara opsional, di bagian Input Tugas pada tugas Konektor, 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. Sebagai contoh, 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 Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 220 di kolom Default Value.

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

Contoh - Membuat catatan

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 Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan 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": "(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 nilai yang mirip 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 Selesai.
  4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan 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 entity Purchases.

Contoh - Menghapus data

Contoh ini menghapus data dengan ID yang ditentukan di entitas Invoices.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Invoices dari daftar Entity.
  3. Pilih operasi Delete, lalu klik Selesai.
  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 nilai yang mirip dengan berikut ini:

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