Zoho Books

Konektor Zoho Books memungkinkan Anda menjalankan operasi SQL di sistem Zoho Books.

Versi yang didukung

Konektor memanfaatkan Zoho Books API V3 untuk mengaktifkan akses dua arah ke data Zoho Books.

Sebelum memulai

Sebelum menggunakan konektor Zoho Books, lakukan tugas berikut:

• Di project Google Cloud Anda:
  • 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 melakukan autentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika 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

Mengonfigurasi konektor mengharuskan Anda 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 Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.

   Buka halaman Connections

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.

      Region yang didukung untuk konektor mencakup:

      Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

   2. Klik Next.
4. Di bagian Connection Details, selesaikan tindakan berikut:
   1. Konektor: Pilih Zoho Books 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 kecil.
      • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh lebih dari 63 karakter.
   4. Secara opsional, masukkan Deskripsi untuk instance koneksi.
   5. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
   6. Secara opsional, konfigurasikan Setelan node koneksi:
      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah maksimum node: Masukkan jumlah maksimum node koneksi.

      {i>Node<i} adalah unit (atau replika) koneksi yang memproses transaksi. Lebih banyak node diperlukan untuk memproses lebih banyak transaksi untuk sebuah koneksi dan sebaliknya, lebih sedikit node diperlukan untuk memproses transaksi yang lebih sedikit. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum akan ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

   Catatan: Anda dapat menyesuaikan nilai node koneksi hanya jika Anda adalah pelanggan Bayar sesuai penggunaan.
   7. Server Akun: URL Server Akun lengkap.
   8. ID Organisasi: ID yang terkait dengan organisasi Zoho Books tertentu.
   9. Tingkat Verbositas: Tingkat panjang untuk koneksi, bervariasi dari 1-5. Tingkat panjang yang lebih tinggi akan mencatat semua detail komunikasi (sertifikat permintaan,respons & SSL).
   10. Secara opsional, klik + Add label untuk menambahkan label ke Connection dalam bentuk key-value pair.
   11. Klik Next.
5. Di bagian Authentication, masukkan detail autentikasi.
   1. Pilih Jenis autentikasi, lalu masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Zoho Books:

      • Pemberian Kode Autentikasi OAuth 2.0

   Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

   2. Klik Next.
6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
7. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

• Pemberian Kode Autentikasi OAuth 2.0
  • Client-ID: Client ID yang diberikan oleh konektor untuk aplikasi yang Anda buat.
  • Rahasia Klien: Secret Manager yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
  • Token Akses: Secret Manager yang berisi token akses OAuth yang disediakan untuk aplikasi terhubung yang Anda buat.

Entitas, operasi, dan tindakan

Semua Integration Connectors menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entity, 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 entity berbeda dari konektor ke konektor. Misalnya, pada konektor database, tabel adalah entity, pada konektor server file, folder adalah entity, dan di konektor sistem pesan, antrean adalah entity.

  Namun, mungkin saja konektor tidak mendukung atau memiliki entitas, 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 entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk deskripsi operasi secara mendetail, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung salah satu operasi entity, operasi yang tidak didukung tersebut tidak akan dicantumkan 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 bervariasi dari satu konektor ke konektor lainnya. Namun, mungkin saja konektor tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Tindakan

Bagian ini mencantumkan beberapa tindakan yang didukung oleh koneksi Zoho Books. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Catatan: Hasil semua tindakan akan tersedia sebagai respons JSON dalam parameter respons connectorOutputPayload tugas Connectors setelah Anda menjalankan integrasi.

Tindakan ImportCreditCardStatement

Tindakan ini memungkinkan Anda mengimpor laporan keranjang kredit.

Masukkan parameter tindakan ImportCreditCardStatement

Nama parameter	Jenis data	Diperlukan	Deskripsi
AccountId	String	Tidak	ID rekening Bank/Kartu Kredit
TransactionsTransactionDebitOrCredit	String	Tidak	Menunjukkan apakah transaksi berupa Debit atau Kredit.
TransactionsTransactionAmount	String	Tidak	Jumlah yang terlibat dalam transaksi.
TransactionsTransactionDescription	String	Tidak	Deskripsi transaksi.
TransactionsTransactionDate	String	Tidak	Tanggal Transaksi.

Untuk memahami cara mengonfigurasi tindakan ImportCreditCardStatement, lihat Contoh.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan dalam konektor ini.

Contoh - Mengimpor laporan mutasi kartu kredit

Contoh ini mengimpor laporan mutasi kartu kredit.

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan ImportCreditCardStatement, lalu klik Done.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
     "AccountId": "1470449000000023015",
     "TransactionsTransactionDebitOrCredit": "credit",
     "TransactionsTransactionAmount": "200",
     "TransactionsTransactionDescription": "Transaction done from Google account",
     "TransactionsTransactionDate": "2023-05-05"
   }

Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas ImportCreditCardStatement akan memiliki nilai yang mirip dengan yang berikut:

[{
"Status": "Your bank statement has been imported."
}]

Contoh operasi entitas

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

Contoh - Menampilkan daftar semua estimasi

Contoh ini mencantumkan semua kumpulan data dalam entity Estimates.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Estimates dari daftar Entity.
3. Pilih operasi List, lalu klik Done.
4. Secara opsional, di bagian Task Input pada tugas Connectors, Anda dapat memfilter kumpulan hasil dengan menentukan klausa filter. Anda juga dapat menentukan beberapa kondisi filter menggunakan operator logika.

Contoh - Mendapatkan pesanan penjualan

Contoh ini mendapatkan pesanan penjualan yang ditentukan dari entitas SalesOrder.

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

   Di sini, 1470449000000043003 adalah nilai kunci utama dalam entity SalesOrder.

Contoh - Membuat transaksi bank

Contoh ini membuat catatan transaksi bank dalam entity BankTransactions.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih BankTransactions 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:

   {
   "TransactionType": "transfer_fund",
   "FromAccountId": "1470449000000000459",
   "ToAccountId": "1470449000000110001",
   "Amount": 45.0,
   "CurrencyId": "1470449000000000064"
   }

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

   {
   "TransactionId": "1470449000000231005"
   }

Contoh - Memperbarui detail kontak pelanggan

Contoh ini memperbarui data pelanggan yang ditentukan dalam entity CustomerContacts.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih CustomerContacts 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:

   {
   "Department": "Development",
   "ContactId": "1470449000000038003"
   }

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

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

{
"CustomerContactId": "1470449000000038005"
}

Contoh - Menghapus data faktur

Contoh ini menghapus catatan invoice yang ditentukan dalam entity InvoiceDetails.

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih InvoiceDetails dari daftar Entity.
3. Pilih operasi Delete, lalu klik Done.
4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 1470449000000184001 di kolom Default Value.

Catatan: Jika entitas Anda memiliki kunci utama gabungan, Anda dapat menentukan klausa filter.

Menggunakan koneksi Zoho Books 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 Integrasi Apigee, lihat Tugas konektor.
• Untuk memahami cara membuat dan menggunakan tugas Konektor dalam Application Integration, lihat tugas konektor.

Dapatkan bantuan dari komunitas Google Cloud

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

Langkah selanjutnya

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