DocuSign

Contoh konfigurasi koneksi

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

OAUTH 2.0 - Jenis koneksi Kode Otorisasi

Jenis koneksi OAuth 2.0 - JWT Bearer

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.

Tindakan

Bagian ini mencantumkan semua tindakan yang didukung oleh koneksi DocuSign.

Tindakan CreateAndSendEnvelope

Membuat dan mengirim amplop atau membuat draf amplop.

Parameter input tindakan CreateAndSendEnvelope

Untuk contoh cara mengonfigurasi tindakan CreateAndSendEnvelope, lihat Contoh.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - CreateAndSendEnvelope

Tindakan ini membuat dan mengirimkan amplop atau membuat draf amplop.

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

   {
   "EmailSubject": "Please Sign this Document",
   "FileName": "test.txt\ntest.pdf",
   "SignersEmail": "cloudysanfrancisco@gmail.com",
   "SignersRecipientId": "53386460",
   "CcRecipientId": "67173451",
   "CcEmail": "baklavainthebalkans@gmail.com",
   "DocumentId": "1",
   "Status": "sent",
   "CustomFieldAggregate": "CustomFieldName",
   "ContentBytes": "abcd***",
   "HasBytes": true,
   "SignersName": "\"test\"",
   "CcName": "\"test\"",
   "Content": "test content in file"
   }
   

Jika tindakan berhasil, parameter respons connectorOutputPayload tugas konektor akan memiliki nilai yang mirip dengan berikut ini:

 [{
"Success":"true",
"envelopeid":"542a77ff-b533-4b39-9d82-e397ef5a70c9",
"uri":"/envelopes/542a77ff-b533-4b39-9d82-e397ef5a70c9",
"statusdatetime":"2025-04-09T12:33:47.1130000Z",
"status":"sent",
"customfieldaggregate": "CustomFieldName"
}]

Contoh operasi entity

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

Nilai untuk ID Entitas harus diteruskan secara langsung, seperti 16ab549b-95d7-47cb-b557-c2476ef62d9d. ID 16ab549b-95d7-47cb-b557-c2476ef62d9d adalah nilai kunci utama unik yang harus diteruskan.

Contoh - Operasi LIST untuk Entity "Accounts"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Akun dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan Anda.

Contoh - Operasi LIST untuk Entity "Documents"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Dokumen dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan Anda.

Contoh - Operasi LIST untuk Entity "Envelopes"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Amplop dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan Anda.

Contoh - Operasi LIST untuk Entity "Folders"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Folder dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan Anda.

Contoh - Operasi LIST untuk Entitas "Grup"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Grup dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan Anda.

Contoh - Operasi LIST untuk Entity "Pengguna"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Pengguna dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan Anda.

Anda juga dapat melakukan operasi LIST pada entitas berikut:

• UserInfo
• UserSignatures
• Ruang kerja
• Penerima
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Kunci
• GroupBrands
• GroupUsers
• PowerForms
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Template

Contoh - GET satu catatan untuk Entitas "Accounts"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Akun dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menyetel ID entitas, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan 2.4578824E7 di kolom Nilai Input dan pilih EntityId sebagai Variabel lokal.

Contoh - GET satu rekaman untuk Entitas "Dokumen"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Dokumen dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Untuk menyetel Klausa Filter, di bagian Pemetaan Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8' di kolom Nilai Input dan pilih Klausa Filter sebagai variabel Lokal.

Contoh - GET satu catatan untuk Entitas "Amplop"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Amplop dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menyetel ID entitas, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 di kolom Nilai Input dan pilih EntityId sebagai Variabel lokal.

Contoh - GET satu rekaman untuk Entitas "Folders"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Folder dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menyetel ID entitas, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan 05f76d13-a513-492b-8c58-176702768db0 di kolom Nilai Input dan pilih EntityId sebagai Variabel lokal.

Contoh - GET satu catatan untuk Entitas "Grup"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Grup dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menyetel ID entitas, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan 1.4167231E7 di kolom Nilai Input dan pilih EntityId sebagai Variabel lokal.

Contoh - GET satu catatan untuk Entity "Pengguna"

1. Dalam dialog Configure connector task, klik Entities.
2. Pilih Pengguna dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menyetel ID entitas, di bagian Pemeta Data pada Pemetaan Data, klik Buka Editor Pemetaan Data, lalu masukkan 16ab549b-95d7-47cb-b557-c2476ef62d9d di kolom Nilai Input dan pilih EntityId sebagai Variabel lokal.

Anda juga dapat melakukan operasi GET pada entitas berikut:

• UserInfo
• UserSignatures
• Ruang kerja
• Penerima
• AccountBrands
• AccountCustomFields
• EnvelopeTemplates
• EnvelopeAttachments
• EnvelopeConsumerDisclosures
• CloudStorageProviders
• CustomTabs
• Kunci
• GroupBrands
• GroupUsers
• RecipientTabs
• SigningGroups
• SigningGroupUsers
• Template