Freshbook

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

Versi yang didukung

Konektor ini membuat model FreshBooks Alpha API sebagai objek database yang dapat dibuat kuerinya dengan SQL.

Sebelum memulai

Sebelum menggunakan konektor Freshbooks, lakukan tugas berikut:

  • Di project Google Cloud Anda:
    • 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 Freshbooks 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.

    7. ID Akun: ID Akun yang akan dihubungkan. Jika nilai tidak ditentukan, nilai pertama yang ditampilkan akan digunakan.
    8. Secara opsional, klik + Add label untuk menambahkan label ke Connection dalam bentuk key-value pair.
    9. Klik Next.
  5. Di bagian Authentication, masukkan detail autentikasi.
    1. Pilih Jenis autentikasi, lalu masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi Freshbooks:

      • Pemberian Kode Autentikasi OAuth 2.0

      2. 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
    • Cakupan: Daftar yang dipisahkan koma dari cakupan yang diinginkan.
    • Client-ID: Client-ID yang digunakan untuk meminta token akses.
    • Rahasia klien: Rahasia klien yang digunakan untuk meminta token akses.

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.

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

    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.

Contoh operasi entitas

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

Contoh - Buat daftar semua project

Contoh ini mencantumkan semua project dalam entity Projects.

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

Contoh - Mendapatkan kumpulan data dari entity

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

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Expense Categories dari daftar Entity.
  3. Pilih operasi Get, lalu klik Done.
  4. 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 dalam entity Invoices.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Invoices 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: 
    {"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 dengan ID 36741.0 dalam entity Invoices.

  1. Dalam dialog Configure connector task, klik Entities.
  2. Pilih Invoices 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: 
    {
"FirstName": "James"
}
  5. Klik entityId, lalu masukkan 36741.0 di kolom Nilai Default.

    Atau, daripada menentukan entityId, Anda juga dapat menetapkan 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 dalam entity Payments.

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

Gunakan terraform untuk membuat koneksi

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 Diperlukan 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 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