ZohoBooks

Konektor ZohoBooks memungkinkan Anda melakukan operasi SQL di sistem ZohoBooks.

Versi yang didukung

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

Untuk mengonfigurasi konektor, Anda harus 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 Konektor Integrasi > Koneksi, 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. Region: Pilih lokasi dari menu drop-down.

      Region yang didukung untuk konektor meliputi:

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

   2. Klik Berikutnya.
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 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. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
   6. Service Account: 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, 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 merupakan pelanggan Bayar sesuai penggunaan.
   8. Server Akun: URL Server Akun lengkap.
   9. ID Organisasi: ID yang terkait dengan organisasi Zoho Books tertentu.
   10. Tingkat Panjang Informasi: Tingkat panjang informasi untuk koneksi, bervariasi dari 1-5. Tingkat panjang informasi yang lebih tinggi akan mencatat semua detail komunikasi (permintaan, respons, & sertifikat SSL).
   11. Secara opsional, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan nilai kunci.
   12. Klik Berikutnya.
5. Di bagian Authentication, masukkan detail autentikasi.
   1. Pilih Jenis autentikasi dan 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 Berikutnya.
6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
7. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

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

Mengonfigurasi autentikasi ZohoBooks

Bagian berikut menjelaskan cara mengonfigurasi konektor ZohoBooks.

Menyiapkan akun ZohoBooks

Untuk informasi selengkapnya tentang cara menyiapkan akun ZohoBooks, lihat Pembuatan akun.

Menyiapkan akun developer dan membuat aplikasi klien

Untuk informasi tentang akun developer ZohoBooks dan pembuatan aplikasi klien, lihat Pembuatan Aplikasi Klien.

Menyiapkan autentikasi

Untuk menyiapkan autentikasi, lakukan hal berikut:

1. Buka halaman Konektor Integrasi di Konsol Cloud.
2. Untuk melihat detail koneksi tertentu, klik nama koneksi dalam tabel koneksi yang ada.
3. Di bagian Autentikasi, klik Authorize connection untuk memulai proses otorisasi.
4. Salin URI pengalihan.
5. Buka Konsol Developer ZohoBooks.
6. Di bagian URI pengalihan yang diberi otorisasi klien aplikasi berbasis Layanan, tambahkan URI pengalihan.
7. Di halaman Konektor Integrasi, buka halaman koneksi ZohoBooks tempat Anda menyalin URI pengalihan, lalu klik Otorisasi.

Anda akan dialihkan ke situs ZohoBooks untuk memberikan otorisasi.

Contoh konfigurasi koneksi

Bagian ini mencantumkan contoh nilai untuk berbagai kolom yang Anda konfigurasi saat membuat koneksi Zoho Books.

Jenis koneksi web

Nama kolom	Detail
Wilayah	us-east4
Konektor	ZohoBooks
Versi konektor	1
Nama Koneksi	zohobooks-google-cloud-conn
Akun Layanan	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Server Akun	https://books.zoho.in
ID Organisasi	ORGANIZATION_ID
Banyaknya pembacaan	5
Jumlah minimum node	2
Jumlah maksimum node	50
ID klien	CLIENT_ID
Cakupan	ZohoBooks.fullaccess.all
Rahasia Klien	CLIENT_SECRET
Versi rahasia	1

Menggunakan koneksi ZohoBooks 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.

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.

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 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:
  • Cantumkan
  • Dapatkan
  • Buat
  • Update
  • Hapus

  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.

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 entity 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 memuat ulang skema secara manual. Untuk memuat ulang skema koneksi, buka halaman Connection details koneksi, lalu klik Refresh connection schema.

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 mutasi kartu kredit.

Parameter input tindakan ImportCreditCardStatement

Nama parameter	Jenis data	Wajib	Deskripsi
AccountId	String	Tidak	ID rekening Bank/Kartu Kredit
TransactionsTransactionDebitOrCredit	String	Tidak	Menunjukkan apakah transaksi adalah 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 di konektor ini.

Contoh - Mengimpor laporan mutasi kartu kredit

Contoh ini mengimpor laporan mutasi kartu kredit.

1. Pada dialog Configure connector task, klik Actions.
2. Pilih tindakan ImportCreditCardStatement, lalu klik Selesai.
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 berhasil, parameter respons connectorOutputPayload tugas ImportCreditCardStatement akan memiliki nilai yang mirip dengan berikut:

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

Contoh operasi entity

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

Contoh - Mencantumkan semua estimasi

Contoh ini mencantumkan semua data dalam entitas Estimates.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Estimates dari daftar Entity.
3. Pilih operasi List, lalu klik Selesai.
4. Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat memfilter set 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. Pada dialog Configure connector task, klik Entities.
2. Pilih SalesOrder dari daftar Entity.
3. Pilih operasi Get, lalu klik Selesai.
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 di entitas BankTransactions.

1. Pada 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 di entitas CustomerContacts.

1. Pada 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 ini:

{
"CustomerContactId": "1470449000000038005"
}

Contoh - Menghapus data invoice

Contoh ini menghapus data invoice yang ditentukan dalam entitas InvoiceDetails.

1. Pada 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 memiliki kunci utama komposit, Anda dapat menentukan klausa filter.

Mendapatkan bantuan dari komunitas Google Cloud

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

Langkah selanjutnya

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