Zendesk

Konektor Zendesk memungkinkan Anda melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan di database Zendesk.

Versi yang didukung

Konektor ini mendukung Version 2 API Zendesk.

Sebelum memulai

Sebelum menggunakan konektor Zendesk, 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.
Jika Anda ingin menggunakan alamat email dan sandi untuk mengakses Zendesk API, aktifkan password access di pusat admin Zendesk. Untuk mengetahui informasi selengkapnya, lihat Autentikasi dasar.

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:

Di Konsol Cloud, buka halaman Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.
Buka halaman Connections
Klik + CREATE NEW untuk membuka halaman Create Connection.
Di bagian Lokasi, pilih lokasi untuk koneksi.
1. Region: Pilih lokasi dari menu drop-down.
  Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.
2. Klik BERIKUTNYA.
Di bagian Connection Details, selesaikan tindakan berikut:
1. Konektor: Pilih Zendesk 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. Untuk menggunakan koneksi untuk langganan acara, pilih Aktifkan langganan acara. Jika dipilih, opsi berikut akan ditampilkan:
  - Enable event subscription with entity and actions: Pilih opsi ini untuk menggunakan koneksi untuk operasi konektor dan langganan peristiwa (entity dan tindakan).
  - Aktifkan hanya langganan acara: Pilih opsi ini untuk menggunakan koneksi hanya untuk langganan acara.
  Untuk kedua pilihan ini, Anda akan diminta untuk mengonfigurasi detail peristiwa pada langkah berikutnya.
7. 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.
8. Use proxy: Centang kotak ini guna mengonfigurasi server proxy untuk koneksi dan mengonfigurasi nilai berikut:
9. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
10. Klik BERIKUTNYA.
Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
1. Jenis Tujuan: Pilih Jenis Tujuan.
  1. Di kolom Host address, tentukan nama host atau alamat IP tujuan.
    1. Jika ingin membuat koneksi pribadi ke sistem backend, ikuti langkah-langkah berikut:
      1. Buat lampiran layanan PSC.
      2. Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
    2. Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk 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 BERIKUTNYA.
Di bagian Authentication, masukkan detail autentikasi.
1. Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
  Jenis autentikasi berikut didukung oleh koneksi Zendesk:
  - Nama pengguna dan sandi
2. Klik BERIKUTNYA.
Jika Anda telah mengaktifkan langganan acara, bagian Detail Langganan Acara akan muncul di halaman pembuatan koneksi. Untuk memahami cara mengonfigurasi detail langganan peristiwa, lihat Mengonfigurasi langganan peristiwa.
Tinjau: Tinjau detail koneksi dan autentikasi Anda.
Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

Nama pengguna dan sandi
- Username: Nama pengguna Zendesk yang akan digunakan untuk koneksi.
- Sandi: Rahasia Secret Manager berisi sandi yang terkait dengan nama pengguna Zendesk.

Mengonfigurasi langganan acara

Jika Anda telah mengaktifkan langganan acara, masukkan nilai berikut di bagian Detail Langganan Acara:

Pilih Jenis Tujuan.
- Alamat host: Masukkan URL pendaftaran sistem backend Anda di kolom host.
Masukkan detail autentikasi.
1. Username: Masukkan nama pengguna.
2. Sandi: Pilih rahasia Secret Manager yang berisi sandi yang terkait dengan nama pengguna.
3. Secret Version: Pilih versi rahasia.
Secara opsional, pilih Aktifkan pengayaan data jika Anda ingin informasi tambahan ditambahkan ke respons sistem backend.
Informasi tambahan ini khusus untuk entitas yang peristiwanya telah Anda konfigurasi. Untuk mengetahui informasi selengkapnya, lihat Pengayaan data dalam notifikasi peristiwa.

Catatan: Jika telah mengonfigurasi koneksi ini hanya untuk langganan acara, Anda tidak dapat mengaktifkan opsi ini. Untuk mengaktifkan pengayaan data, Anda harus mengonfigurasi koneksi untuk langganan peristiwa dan operasi konektor (entity dan tindakan).
Pilih Aktifkan konektivitas pribadi untuk konektivitas yang aman antara aplikasi backend dan koneksi Anda. Jika memilih opsi ini, Anda harus melakukan langkah konfigurasi tambahan setelah membuat koneksi. Untuk mengetahui informasi selengkapnya, lihat Konektivitas pribadi untuk langganan acara.
Masukkan konfigurasi yang dihentikan pengirimannya. Jika Anda mengonfigurasi huruf mati, koneksi akan menulis peristiwa yang belum diproses ke topik Pub/Sub yang ditentukan. Masukkan detail berikut:
1. ID project yang dihentikan pengirimannya: ID project Google Cloud tempat Anda mengonfigurasi topik Pub/Sub yang dihentikan pengirimannya.
2. Topik yang dihentikan pengirimannya: Topik Pub/Sub tempat Anda ingin menulis detail peristiwa yang belum diproses.
Jika Anda ingin menggunakan proxy untuk terhubung ke backend (untuk langganan peristiwa), masukkan detail berikut:

Jenis SSL Proxy: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Pilih salah satu jenis autentikasi berikut:
- Selalu: Koneksi selalu SSL diaktifkan untuk langganan acara.
- Tidak pernah: Koneksi tidak diaktifkan untuk langganan acara.
Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
- Dasar: Autentikasi HTTP dasar.
Proxy User: Masukkan nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
Sandi Proxy: Pilih rahasia Secret Manager sandi pengguna.
Secret version: Pilih versi secret.
Di bagian Server Proxy, masukkan detail server proxy.
1. Klik + Add destination, lalu pilih Destination Type sebagai Host address.
2. Masukkan nama host atau alamat IP server proxy, dan nomor port server proxy.

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

Keterbatasan sistem

Konektor Zendesk dapat memproses 5 transaksi per detik, per node, dan men-throttle setiap transaksi di luar batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk satu koneksi.

Untuk informasi tentang batas yang berlaku untuk Konektor Integrasi, lihat Batas.

Catatan: Jumlah node Konektor Integrasi akan diskalakan otomatis secara dinamis berdasarkan penggunaan Anda. Namun, jika ingin mencadangkan kapasitas untuk volume besar tanpa menunggu penskalaan otomatis, Anda dapat menyesuaikan nilai node minimum untuk koneksi. Perlu lebih banyak node untuk memproses lebih banyak transaksi untuk sebuah koneksi. Sebaliknya, lebih sedikit node yang diperlukan jika koneksi memproses transaksi yang lebih sedikit. Untuk mengonfigurasi nilai node, lakukan langkah berikut:

Jika Anda adalah pelanggan yang membayar sesuai penggunaan, konfigurasikan nilai node minimum dan maksimum di halaman edit koneksi.
Jika Anda adalah pelanggan yang berbasis langganan, hubungi dukungan.

Transaksi maksimum yang dapat ditangani node bergantung pada berbagai faktor. Jadi, sebelum menyesuaikan node minimum untuk throughput yang lebih baik, sebaiknya periksa apakah sistem backend Anda sudah disiapkan secara optimal untuk menangani traffic yang diperlukan.

Tindakan

Konektor Zendesk menyediakan tindakan untuk mengelola tiket Anda berdasarkan ticket ID. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan dalam konektor ini.

Contoh - Menghapus tiket

Dalam dialog Configure connector task, klik Actions.
Pilih tindakan DeleteTicketsPermanently, lalu klik Done.
Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
```
{
  "Id": "18"
}
```

Contoh ini menghapus tiket secara permanen. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

[{
  "Success": "true"
}]

Catatan: Operasi DeleteTicketsPermanently akan menghapus data secara permanen. Jika Anda ingin melakukan penghapusan untuk sementara, gunakan operasi Penghapusan entitas.

Contoh - Menggabungkan tiket

Dalam dialog Configure connector task, klik Actions.
Pilih tindakan MergeTickets, lalu klik Done.
Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
```
{
  "Id": "25",
  "Id": "26"
}
```

Contoh ini menggabungkan kedua tiket. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

[{
  "Success": null,
  "Message": null
}]

Contoh - Memulihkan tiket

Dalam dialog Configure connector task, klik Actions.
Pilih tindakan RestoreTicket, lalu klik Done.
Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
```
{
  "id": "20"
}
```

Contoh ini akan memulihkan tiket. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

[{
  "Success": "true"
}]

Contoh - Memulihkan tiket yang ditangguhkan

Dalam dialog Configure connector task, klik Actions.
Pilih tindakan RecoverSuspendedTicket, lalu klik Done.
Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:
```
{
  "id": "18726501985809"
}
```

Contoh ini akan memulihkan tiket yang ditangguhkan. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

[{
  "Id": "60921"
}]

Contoh operasi entitas

Contoh - Mencantumkan semua tiket

Contoh ini mencantumkan semua tiket dalam entity Tickets.

Dalam dialog Configure connector task, klik Entities.
Pilih Tiket dari daftar Entity.
Pilih operasi LIST, lalu klik Done.

Contoh - Dapatkan tiket

Contoh ini mendapatkan tiket yang ID-nya 35 dari entity Tickets.

Dalam dialog Configure connector task, klik Entities.
Pilih Tickets dari daftar Entity.
Pilih operasi GET, lalu klik Done.
Di bagian Task Input pada tugas Connectors, klik EntityId lalu masukkan 35 di kolom Default Value.
Di sini, 35 adalah nilai kunci utama entity Tickets.

Contoh - Membuat tiket

Contoh ini membuat tiket dalam entity Tickets.

Dalam dialog Configure connector task, klik Entities.
Pilih Tickets dari daftar Entity.
Pilih operasi Create, lalu klik Done.

Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

{
    "Subject": "Zendesk_Create_Ticket",
    "Description": "Test",
    "Type": "incident",
    "Priority": "urgent",
    "Status": "open",
    "Recipient": null,
    "HasIncidents": false,
    "DueAt": null,
    "RequesterId": 3.84625885158E11,
    "SubmitterId": 3.84625883418E11,
    "AssigneeId": 3.84625883418E11,
    "OrganizationId": "16665992392721",
    "GroupId": 3.60008282358E11,
    "TicketFormId": 3.60001719218E11,
    "BrandId": 3.60003285058E11
  }

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

 {
    "Id": 38.0
  }

Contoh - Memperbarui tiket

Contoh ini memperbarui tiket yang ID-nya adalah 35 di entity Tickets.

Dalam dialog Configure connector task, klik Entities.
Pilih Tiket dari daftar Entity.
Pilih operasi Update, lalu klik Done.

Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

{
      "Subject": "Zendesk_Ticket_Update",
      "Description": "Updating the ticket",
      "RequesterId": 1.6854335860497E13
    }

Klik entityId, lalu masukkan 35 di kolom Nilai Default.
Atau, daripada menentukan entityId, Anda juga dapat menetapkan filterClause ke 35.

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

Contoh - Menghapus tiket

Contoh ini menghapus tiket yang ID-nya adalah 35 di entity Tickets.

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

Catatan: Operasi Delete hanya melakukan penghapusan untuk sementara pada data. Jika diperlukan, Anda dapat memulihkan data yang dihapus nanti.

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
proxy_enabled	BOOLEAN	Salah	Pilih kotak centang ini untuk mengonfigurasi server proxy untuk koneksi.
proxy_auth_scheme	ENUM	Salah	Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE
proxy_user	STRING	Salah	Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
proxy_password	SECRET	Salah	Sandi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
proxy_ssltype	ENUM	Salah	Jenis SSL yang akan digunakan saat menghubungkan ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, WorkManager

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