Halaman ini diterjemahkan oleh Cloud Translation API.

Freshbooks

Konektor FreshBooks memungkinkan Anda terhubung ke instance FreshBooks dan mengakses data FreshBooks sebagai database tradisional.

Versi yang didukung

Konektor ini memodelkan FreshBooks Alpha API sebagai objek database yang dapat dikueri dengan SQL.

Sebelum memulai

Sebelum menggunakan konektor Freshbooks, lakukan tugas berikut:

Di project Google Cloud Anda:
- Pastikan konektivitas jaringan telah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
- 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.

Untuk mengetahui informasi tentang cara membuat aplikasi dan membuat client ID serta rahasia klien untuk autentikasi, lihat Mulai Menggunakan FreshBooks API.

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:

Di Konsol Cloud, buka halaman Integration Connectors > Connections lalu pilih atau buat project Google Cloud.
Buka halaman Koneksi
Klik + Buat baru untuk membuka halaman Buat Koneksi.
Di bagian Location, pilih lokasi untuk koneksi.
1. Wilayah: Pilih lokasi dari menu drop-down.
  Region yang didukung untuk konektor meliputi:
  Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.
2. Klik Berikutnya.
Di bagian Detail Koneksi, selesaikan langkah-langkah berikut:
1. Konektor: Pilih Freshbooks 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 Deskripsi untuk instance koneksi.
5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
6. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
7. 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.
8. ID Akun: ID Akun yang akan dihubungkan. Jika nilai tidak ditentukan, nilai pertama yang ditampilkan akan digunakan.
9. Atau, klik + Tambahkan label untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
10. Klik Berikutnya.
Di bagian Authentication, masukkan detail autentikasi.
1. Pilih Jenis autentikasi dan masukkan detail yang relevan.
  Jenis autentikasi berikut didukung oleh koneksi Freshbooks:
  - Pemberian Kode Otorisasi OAuth 2.0
2. Klik Berikutnya.
Tinjau: Tinjau detail koneksi dan autentikasi Anda.
Klik Buat.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

Pemberian Kode Otorisasi OAuth 2.0
- Cakupan: Daftar cakupan yang diinginkan, dipisahkan koma.
- Client ID: Client ID yang digunakan untuk meminta token akses.
- Rahasia klien: Rahasia klien yang digunakan untuk meminta token akses.

Untuk memberikan otorisasi pada koneksi FreshBooks, lakukan hal berikut:

Dari halaman Koneksi, klik koneksi FreshBooks.
Di bagian Authentication, klik Authorize Connection.
Buka bagian URI pengalihan, lalu salin.
Di aplikasi FreshBooks, klik Redirect URIs.
Tempelkan URI pengalihan yang Anda salin dari koneksi FreshBooks, lalu klik Save Settings.
Kembali ke koneksi FreshBooks, klik Authorize dari bagian autentikasi.
Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

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:
- Daftar
- 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 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.

Contoh operasi entity

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

Contoh - Mencantumkan semua project

Contoh ini mencantumkan semua project dalam entitas Projects.

Dalam dialog Configure connector task, klik Entities.
Pilih Projects dari daftar Entity.
Pilih operasi List, lalu klik Selesai.
Secara opsional, di bagian Input Tugas pada tugas Konektor, Anda dapat memfilter kumpulan hasil dengan menentukan klausa filter.

Contoh - Mendapatkan rekaman dari entity

Contoh ini mengambil data yang ID-nya adalah 2009015 dari entity Expense Categories.

Dalam dialog Configure connector task, klik Entities.
Pilih Expense Categories dari daftar Entity.
Pilih operasi Get, lalu klik Selesai.
Di bagian Task Input pada tugas Connectors, klik EntityId, lalu masukkan 2009015 di kolom Default Value.
Di sini, 2009015 adalah nilai kunci utama dalam entity Expense Categories.

Contoh - Membuat invoice

Contoh ini membuat invoice di entitas Invoices.

Dalam dialog Configure connector task, klik Entities.
Pilih Invoices dari daftar Entity.
Pilih operasi Create, lalu klik Selesai.
Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
```
{"CustomerId": 68039.0,
"FirstName": "John",
"CreateDate": "2023-09-13"
}
```
Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:
```
{
"Id": "49594.0"
}
```

Contoh - Memperbarui invoice

Contoh ini memperbarui invoice yang ID-nya adalah 36741.0 di entity Invoices.

Dalam dialog Configure connector task, klik Entities.
Pilih Invoices dari daftar Entity.
Pilih operasi Update, lalu klik Selesai.
Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
```
{
"FirstName": "James"
}
```
Klik entityId, lalu masukkan 36741.0 di kolom Default Value.
Atau, alih-alih menentukan entityId, Anda juga dapat menyetel filterClause ke 36741.0.

Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:
```
{
"Id": "36741.0"
}
```

Contoh - Menghapus data

Contoh ini menghapus data yang ID-nya 78 di entitas Payments.

Dalam dialog Configure connector task, klik Entities.
Pilih Payments dari daftar Entity.
Pilih operasi Delete, lalu klik Selesai.
Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 78 di kolom Default Value.

Membuat koneksi menggunakan Terraform

Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.

Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:

Nama parameter	Jenis data	Wajib	Deskripsi
account_id	STRING	Benar	ID Akun yang akan dihubungkan. Jika nilai tidak ditentukan, nilai pertama yang ditampilkan akan digunakan.

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

Mendapatkan bantuan dari komunitas Google Cloud

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

Langkah berikutnya

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