Zendesk

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

• Nama pengguna dan sandi
  • Nama pengguna: Nama pengguna Zendesk yang akan digunakan untuk koneksi.
  • Password: Secret Manager secret yang berisi sandi yang terkait dengan nama pengguna Zendesk.
• Token API
  • Pengguna: Akun pengguna Zendesk yang digunakan untuk mengautentikasi.
  • Token API: Token API pengguna yang diautentikasi.
  • Versi rahasia: Versi rahasia untuk secret.
• OAuth 2.0 - Kode otorisasi
  • Client ID: Client ID yang diberikan oleh konektor untuk aplikasi yang Anda buat.
  • Cakupan: Daftar cakupan yang diinginkan, dipisahkan koma.
  • Rahasia klien: Secret Manager Secret yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
  • Versi rahasia: Versi rahasia untuk secret.
  • Authorization URL: URL otorisasi yang dibuat saat membuat klien di instance Zendesk.

Mengonfigurasi langganan acara

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

1. Pilih Jenis Tujuan.
   • Alamat host: Masukkan URL pendaftaran sistem backend Anda di kolom host.
2. Masukkan detail autentikasi.
   1. Nama pengguna: Masukkan nama pengguna.
   2. Sandi: Pilih rahasia Secret Manager yang berisi sandi yang terkait dengan nama pengguna.
   3. Versi Secret: Pilih versi secret.
3. Secara opsional, pilih Aktifkan pengayaan data jika Anda ingin informasi tambahan ditambahkan ke respons sistem backend.

   Informasi tambahan ini khusus untuk entitas yang telah Anda konfigurasi peristiwanya. Untuk mengetahui informasi selengkapnya, lihat Pengayaan data dalam notifikasi peristiwa.

4. Pilih Aktifkan konektivitas pribadi untuk konektivitas yang aman antara aplikasi backend dan koneksi Anda. Jika memilih opsi ini, Anda harus melakukan langkah-langkah konfigurasi tambahan setelah membuat koneksi. Untuk mengetahui informasi selengkapnya, lihat Konektivitas pribadi untuk langganan peristiwa.
5. Masukkan konfigurasi pesan yang dihentikan pengirimannya. Jika Anda mengonfigurasi pesan yang dihentikan pengirimannya, koneksi akan menulis peristiwa yang belum diproses ke topik Pub/Sub yang ditentukan. Masukkan detail berikut:
   1. Project ID pesan yang tidak terkirim: Project ID Google Cloud tempat Anda mengonfigurasi topik Pub/Sub pesan yang tidak terkirim.
   2. Topik yang dihentikan pengirimannya: Topik Pub/Sub tempat Anda ingin menulis detail peristiwa yang belum diproses.
6. Jika Anda ingin menggunakan proxy untuk terhubung ke backend (untuk langganan acara), masukkan detail berikut:
1. Jenis SSL Proxy: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Pilih salah satu jenis autentikasi berikut:
   • Selalu: Koneksi selalu diaktifkan SSL untuk langganan acara.
   • Tidak Pernah: Koneksi tidak diaktifkan untuk SSL untuk langganan acara.
2. Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
   • Dasar: Autentikasi HTTP dasar.
3. Pengguna Proxy: Masukkan nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
4. Sandi Proxy: Pilih secret Secret Manager dari sandi pengguna.
5. Versi secret: Pilih versi secret.
6. Di bagian Server Proxy, masukkan detail server proxy.
   1. Klik + Tambahkan tujuan, lalu pilih Jenis Tujuan sebagai Alamat host.
   2. Masukkan nama host atau alamat IP server proxy, dan nomor port server proxy.

Contoh konfigurasi koneksi

Jenis koneksi autentikasi dasar

Jenis koneksi Token API

OAuth 2.0 - Jenis koneksi kode otorisasi

Koneksi ke Zendesk menggunakan SSL secara default, dan tidak ada konfigurasi tambahan yang diperlukan jika Anda menggunakan URL Zendesk standar, seperti https://yoursubdomain.zendesk.com.

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.

Batasan sistem

Konektor Zendesk dapat memproses 5 transaksi per detik, per node, dan membatasi transaksi apa pun yang melebihi batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Integration Connectors, lihat Batas.

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 di konektor ini.

Contoh - Menghapus tiket

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

[{
  "Success": "true"
}] 

Contoh - Menggabungkan tiket

1. Dalam dialog Configure connector task, klik Actions.
2. Pilih tindakan MergeTickets, lalu klik Selesai.
3. 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 dua tiket. Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:

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

Contoh - Memulihkan tiket

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

   {
     "id": "20"
   }

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

[{
  "Success": "true"
}] 

Contoh - Memulihkan tiket yang ditangguhkan

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

   {
     "id": "18726501985809"
   }

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

[{
  "Id": "60921"
}]

Contoh operasi entity

Contoh - Operasi daftar di Tiket

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Tickets dari daftar Entity.
3. Pilih operasi List, lalu klik Selesai.

Anda dapat melakukan operasi List pada entitas berikut:

Lampiran, Komentar Tiket, Formulir Tiket, Kolom Tiket, Permintaan, Audit Tiket, Metrik Tiket, Tiket yang Ditangguhkan, Perjanjian Berbagi, Pengguna, UserIdentities, UserRelatedInformation, UserFields, OrganizationFields, dan JobStatus

Contoh - Operasi Get pada Tiket

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Tickets dari daftar Entity.
3. Pilih operasi Get, lalu klikSelesai.
4. Di sini, entityId ditetapkan ke 34.0. Untuk menyetel entityId, di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 34.0 di kolom Default Value.

Anda dapat melakukan operasi Get pada entitas berikut:

Formulir Tiket, Kolom Tiket, Permintaan, Audit Tiket, Tiket yang Ditangguhkan, Kolom Pengguna, UserIdentities, dan Pengguna

Contoh - Operasi pembuatan pada Tiket

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Tickets dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Subject": "Zendesk_Create_Ticket",
       "RawSubject": "Zendesk_Create",
       "Description": "this ticket is related to application integration Create operation",
       "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,
       "Tags": null,
       "ViaChannel": "web",
       "ViaSource": "{\r\n  \"from\": null,\r\n  \"to\": null,\r\n  \"rel\": null\r\n}",
       "CustomFields": null,
       "SatisfactionRating": null,
       "SharingAgreementIds": null,
       "AllowChannelback": false,
       "IsPublic": true,
       "Url": "https://altostrat.zendesk.com/api/v2/tickets/1.json"
     }
     

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

    {
       "Id": 38.0
     }
     

Contoh - Operasi pembuatan di TicketForms

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih TicketForms dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Name": "Altostrat_Zendesk1",
       "RawName": "Altostrat_Zendesk1",
       "DisplayName": "Altostrat_Issues1",
       "RawDisplayName": "Altostrat_Issues1",
       "Position": 2.0,
       "Active": true,
       "EndUserVisible": true,
       "Default": false,
       "InAllBrands": true,
       "RestrictedBrandIds": null,
       "FallbackToDefault": null,
       "AssociatedToBrand": null
     }
     

   Jika integrasi berhasil, parameter respons TicketForms tugas connectorOutputPayload akan memiliki nilai yang mirip dengan berikut:

   {
       "Id":1.8104712053393E13
     }
     

Contoh - Operasi pembuatan di TicketFields

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih TicketFields dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Type": "text",
       "Title": "New field created",
       "RawTitle": null,
       "Description": "Please create the new field",
       "RawDescription": null,
       "Position": 2.0,
       "Active": true,
       "Required": false,
       "CollapsedForAgents": false,
       "RegexpForValidation": null,
       "VisibleInPortal": true,
       "EditableInPortal": true,
       "Tag": null,
       "CreatedAt": "2021-07-06 06:35:19.0",
       "UpdatedAt": "2021-07-06 06:35:19.0",
       "SystemFieldOptions": null,
       "CustomFieldOptions": null,
       "Removable": false
     }
     

   Jika integrasi berhasil, parameter respons TicketFields tugas connectorOutputPayload akan memiliki nilai yang mirip dengan berikut:

   {
       "Id": 1.7139061374865E13
     }
     

Contoh - Operasi pembuatan di SharingAgreements

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih SharingAgreements dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Name": "altostrat.zendesk.com",
       "RemoteSubdomain": "altostrat"
     }
     

   Jika integrasi berhasil, parameter respons SharingAgreements tugas connectorOutputPayload akan memiliki nilai yang mirip dengan berikut:

   {
       "Id": 1.7142672288273E13
     }
     

Contoh - Operasi pembuatan di Pengguna

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Users dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Email": "cloudysanfrancisco@gmail.com",
       "Name": "Altostrat Team"
     }
     

   Jika integrasi berhasil, parameter respons Users tugas connectorOutputPayload akan memiliki nilai yang mirip dengan berikut:

   {
       "Id": 1.7156912480273E13
     }
     

Contoh - Operasi pembuatan di UserIdentities

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih UserIdentities dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "UserId": 3.84637722338E11,
       "Type": "email",
       "Value": "cloudysanfrancisco@gmail.com",
       "Verified": false,
       "Primary": true,
       "DeliverableState": "reserved_example",
       "Url": "https://d3valtostrat1625553311.zendesk.com/api/v2/users/384637722338/identities/368240277818.json"
     }
     

   Jika integrasi berhasil, parameter respons UserIdentities tugas connectorOutputPayload akan memiliki nilai yang mirip dengan berikut:

   {
       "Id": 1.6961185982353E13
     } 
     

Contoh - Operasi pembuatan di UserFields

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih UserFields dari daftar Entity.
3. Pilih operasi Create, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Title": "Support description",
       "Type": "text",
       "Key": "support_description"
     }
     

   Jika integrasi berhasil, parameter respons UserFields tugas connectorOutputPayload akan memiliki nilai yang mirip dengan berikut:

   {
       "Id": 1.7157236761873E13
     }
     

Contoh - Operasi update pada Tiket

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Tickets dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Subject": "Google_Altostrat_Zendesk Update",
       "RawSubject": "Google_Altostrat_Zendesk Update",
       "Description": "this ticket is related to googlecloud application integration update check",
       "RequesterId": 1.6854335860497E13
     }
     

5. Di sini, entityId ditetapkan ke 35.0. Untuk menyetel entityId, klik entityId, lalu masukkan 35 di kolom Nilai Default.

   Selain 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 - Operasi update di TicketForms

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih TicketForms dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Name": "Ticketforms Updated",
       "DisplayName": "Altostrat_Issues1",
       "RawDisplayName": "Altostrat_Issues1"
     }
     

5. Di sini, entityId ditetapkan ke 1.7137314972689E13. Untuk menyetel entityId, klik entityId, lalu masukkan 1.7137314972689E13 di kolom Nilai Default.

   Selain menentukan entityId, Anda juga dapat menetapkan filterClause ke 1.7137314972689E13.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
         Id": 1.7137314972689E13
     }
     

Contoh - Operasi update pada TicketFields

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih TicketFields dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Description": "Updated description for testing"
     }
     

5. Di sini, entityId ditetapkan ke 3.60022990118E11. Untuk menyetel entityId, klik entityId, lalu masukkan 3.60022990118E11 di kolom Nilai Default.

   Selain menentukan entityId, Anda juga dapat menetapkan filterClause ke 3.60022990118E11.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
         Id": 3.60022990118E11
     }
     

Contoh - Operasi pembaruan pada Pengguna

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Users dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Name": "The Customer update",
       "Last Name": "Alex",
       "First Name": "Charlie"
     }
     

5. Di sini, entityId ditetapkan ke 3.84625885158E11. Untuk menyetel entityId, klik entityId, lalu masukkan 3.84625885158E11 di kolom Nilai Default.

   Selain menentukan entityId, Anda juga dapat menetapkan filterClause ke 3.84625885158E11.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
         Id": 3.84625885158E11
     }
     

Contoh - Operasi update di UserFields

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih UserFields dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Title": "Support description updated",
       "Type": "text",
       "Key": "support_description"
     }
     

5. Di sini, entityId ditetapkan ke 1.7157236761873E13. Untuk menyetel entityId, klik entityId, lalu masukkan 1.7157236761873E13 di kolom Nilai Default.

   Selain menentukan entityId, Anda juga dapat menetapkan filterClause ke 1.7157236761873E13.

   Menjalankan contoh ini akan menampilkan respons yang mirip dengan berikut dalam variabel output connectorOutputPayload tugas Connector:

   {
         Id": 1.7157236761873E13
     }
     

Contoh - Operasi pembaruan pada UserIdentities

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih UserIdentities dari daftar Entity.
3. Pilih operasi Update, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
       "Verified": true
     }
     

5. Dalam entitas ini, operasi Update dapat dilakukan dengan menggunakan klausa filter dan kunci utama komposit sehingga entityId tidak diperlukan.

Daripada menentukan entityId, Anda juga dapat menetapkan filterClause sebagai UserId='384625885158' and Id='368234205078' .

Dengan menjalankan contoh ini, respons yang mirip dengan berikut akan ditampilkan dalam variabel output connectorOutputPayload tugas konektor:

{
    "Id": 3.68234205078E11
  }
  

Contoh - Operasi penghapusan pada Tiket

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Tickets dari daftar Entity.
3. Pilih operasi Delete, lalu klik Selesai.
4. Di sini, entityId ditetapkan ke 35.0. Untuk menyetel entityId, di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 35 di kolom Default Value.

Anda dapat melakukan operasi Hapus pada entity berikut:

Kolom Tiket, Tiket yang Ditangguhkan, UserIdentities, Kolom Pengguna, dan Pengguna

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 Apigee Integration, lihat Tugas konektor.
• Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.