DocuSign
Gunakan konektor DocuSign untuk melakukan operasi baca di DocuSign.
Sebelum memulai
Sebelum menggunakan konektor DocuSign, lakukan tugas berikut:
- Dalam project Google Cloud Anda:
- Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
- 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.viewerroles/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 Anda tidak memiliki akun layanan, Anda harus membuat akun layanan. Konektor dan akun layanan harus termasuk dalam project yang sama. 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.
Mengonfigurasi konektor
Koneksi bersifat spesifik 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.
- Klik + CREATE NEW untuk membuka halaman Create Connection.
- Di bagian Location, pilih lokasi untuk koneksi.
- Region: Pilih lokasi dari menu drop-down.
Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.
- Klik NEXT.
- Region: Pilih lokasi dari menu drop-down.
- Di bagian Connection Details, selesaikan langkah-langkah berikut:
- Connector: Pilih DocuSign dari menu drop-down Connector yang tersedia.
- Connector version: Pilih Connector version dari menu drop-down versi yang tersedia.
- 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 berupa huruf kecil.
- Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
- Nama koneksi tidak boleh melebihi 49 karakter.
- Secara opsional, masukkan Description untuk instance koneksi.
- Secara opsional, aktifkan Cloud logging,
lalu pilih level log. Secara default, level log ditetapkan ke
Error. - Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
- Atau, pilih UseSandbox jika Anda menggunakan akun sandbox DocuSign.
- Jika perlu, konfigurasikan Connection node settings:
- Minimum number of nodes: Masukkan jumlah minimum node koneksi.
- Maximum number of nodes: Masukkan jumlah maksimum node koneksi.
Node adalah unit (atau replika) koneksi yang memproses transaksi. Jumlah node yang diperlukan meningkat saat jumlah transaksi yang diproses bertambah, dan sebaliknya, jumlah node yang diperlukan berkurang saat jumlah transaksi yang diproses 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.
- Atau, klik + ADD LABEL untuk menambahkan label ke Connection dalam bentuk pasangan kunci/nilai.
- Klik NEXT.
-
Di bagian Authentication, masukkan detail autentikasi.
- Pilih Jenis autentikasi dan masukkan detail yang relevan.
Jenis autentikasi berikut didukung oleh koneksi DocuSign:
- OAUTH 2.0 - Kode Otorisasi
- OAuth 2.0 - JWT Bearer
- Klik NEXT.
Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.
- Pilih Jenis autentikasi dan masukkan detail yang relevan.
- Tinjau: Tinjau detail koneksi dan autentikasi Anda.
- Klik Create.
Mengonfigurasi autentikasi
Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.
- OAUTH 2.0 - Kode Otorisasi
- Client ID: Client ID yang digunakan untuk meminta token akses.
- Cakupan: Daftar cakupan yang diinginkan, dipisahkan dengan koma.
- Client Secret: Secret Manager Secret yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
- URL Otorisasi: Masukkan URL untuk otorisasi, seperti
https://account.docusign.com/oauth/authuntuk akun produksi atauhttps://account-d.docusign.com/oauth/authuntuk akun sandbox.
-
OAuth 2.0 - JWT Bearer
- Connected App Consumer Key:Kunci konsumen yang disediakan untuk aplikasi terhubung yang Anda buat.
- Username: Nama pengguna yang terkait dengan aplikasi terhubung yang Anda buat.
- Private Key: Secret Manager Secret yang berisi konten file kunci pribadi. Kunci pribadi harus cocok dengan kunci publik/sertifikat yang diberikan ke Connector.
Contoh konfigurasi koneksi
Bagian ini mencantumkan nilai contoh untuk berbagai kolom yang Anda konfigurasi saat membuat koneksi.
Jenis koneksi OAUTH 2.0 - Authorization Code
| Nama kolom | Detail |
|---|---|
| Lokasi | us-central1 |
| Konektor | DocuSign |
| Versi konektor | 1 |
| Nama Koneksi | gcp-docusign-new-auth |
| Mengaktifkan Cloud Logging | Tidak |
| UseSandbox | Ya |
| Akun Layanan | 123456789012-compute@developer.gserviceaccount.com |
| Autentikasi | OAuth 2.0 - Kode otorisasi |
| Client ID | 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79 |
| Cakupan | tanda tangan |
| Rahasia klien | CLIENT_SECRET |
| Versi Secret | 1 |
| URL otorisasi | https://account-d.docusign.com/oauth/auth |
Jenis koneksi OAuth 2.0 - JWT Bearer
| Nama kolom | Detail |
|---|---|
| Lokasi | us-central1 |
| Konektor | DocuSign |
| Versi konektor | 1 |
| Nama Koneksi | gcp-docusign-token |
| Mengaktifkan Cloud Logging | Tidak |
| UseSandbox | Ya |
| Akun Layanan | 123456789012-compute@developer.gserviceaccount.com |
| Autentikasi | OAuth 2.0 - JWT Bearer |
| Kunci Konsumen Aplikasi Terhubung | 67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79 |
| Nama pengguna | USER_NAME |
| Kunci Pribadi | PRIVATE_KEY |
| Versi Secret | 1 |
Entity, operasi, dan tindakan
Semua Integration Connectors menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ini 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 satu konektor ke konektor lainnya. Misalnya, dalam konektor database, tabel adalah entity, dalam konektor server file, folder adalah entity, dan dalam konektor sistem pesan, antrean adalah entity.
Namun, ada kemungkinan konektor tidak mendukung atau tidak memiliki entity, sehingga daftar
Entitiesakan kosong. - Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan
operasi berikut pada entity:
Memilih entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk mengetahui deskripsi mendetail tentang operasi, lihat operasi entity tugas Connectors. Namun, jika konektor tidak mendukung operasi entity apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar
Operations. - Tindakan: Tindakan adalah fungsi first class yang disediakan untuk integrasi
melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan
bervariasi dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, ada kemungkinan
konektor tidak mendukung tindakan apa pun, sehingga daftar
Actionsakan kosong.
Batasan sistem
Konektor DocuSign dapat memproses 3 transaksi per detik, per node, dan men-throttle transaksi apa pun yang melebihi batas ini. Secara default, Integration Connectors mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk sebuah koneksi.
Untuk mengetahui informasi tentang batas yang berlaku untuk Integration Connectors, lihat Batas.
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
| Nama parameter | Jenis data | Wajib | Deskripsi |
|---|---|---|---|
| FileName | String | Ya | Nama dokumen. |
| DocumentId | String | Ya | ID untuk dokumen. |
| EmailSubject | String | Ya | Baris subjek untuk email. |
| Isi | String | Ya | Konten dalam file. |
| SignersEmail | String | Tidak | ID Email penanda tangan dokumen. |
| SignersRecipientId | String | Tidak | ID Penerima penanda tangan. |
| CcRecipientId | String | Tidak | ID Penerima dari penerima yang disalin dalam email. |
| CcEmail | String | Tidak | ID Email penerima yang disalin dalam email. |
| Status | String | Tidak | Status amplop. Tetapkan status ke "sent" untuk mengirim amplop ke penerima. |
| CustomFieldAggregate | String | Tidak | Anda dapat menggunakan kolom berikut: CustomFieldName, CustomFieldId, CustomFieldShow, CustomFieldRequired, CustomFieldValue, CustomFieldConfiguration, dan CustomFieldListItems. |
| SignersName | String | Tidak | Nama penanda tangan dokumen. |
| CcName | String | Tidak | Nama penerima Cc. |
Untuk contoh cara mengonfigurasi tindakan CreateAndSendEnvelope,
lihat Contoh.
Contoh tindakan
Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.
Contoh - CreateAndSendEnvelope
Tindakan ini akan membuat dan mengirim amplop atau membuat draf amplop.
- Dalam dialog
Configure connector task, klikActions. - Pilih tindakan
CreateAndSendEnvelope, lalu klik Selesai. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload, lalu masukkan nilai yang mirip dengan nilai berikut di kolomDefault 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 entity 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"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Akun dari daftar
Entity. - Pilih operasi
LIST, lalu klik Done. - Di bagian Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan.
Contoh - Operasi LIST untuk Entity "Documents"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Dokumen dari daftar
Entity. - Pilih operasi
LIST, lalu klik Done. - Di bagian Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan.
Contoh - Operasi LIST untuk Entity "Envelopes"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Amplop dari daftar
Entity. - Pilih operasi
LIST, lalu klik Done. - Di bagian Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan.
Contoh - Operasi LIST untuk Entity "Folders"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Folder dari daftar
Entity. - Pilih operasi
LIST, lalu klik Done. - Di bagian Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan.
Contoh - Operasi LIST untuk Entity "Groups"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Grup dari daftar
Entity. - Pilih operasi
LIST, lalu klik Done. - Di bagian Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan.
Contoh - Operasi LIST untuk Entity "Users"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Users dari daftar
Entity. - Pilih operasi
LIST, lalu klik Done. - Di bagian Task Input pada tugas Connectors, Anda dapat menetapkan filterClause sesuai kebutuhan.
Anda juga dapat melakukan operasi LIST pada entity berikut:
- UserInfo
- UserSignatures
- Ruang kerja
- Penerima
- AccountBrands
- AccountCustomFields
- EnvelopeTemplates
- EnvelopeAttachments
- EnvelopeConsumerDisclosures
- CloudStorageProviders
- CustomTabs
- Kunci
- GroupBrands
- GroupUsers
- PowerForms
- RecipientTabs
- SigningGroups
- SigningGroupUsers
- Template
Contoh - GET satu data untuk Entity "Accounts"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Akun dari daftar
Entity. - Pilih operasi
GET, lalu klik Done. - Untuk menetapkan ID entity, di
bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu
masukkan
2.4578824E7di kolom Input Value dan pilih EntityId sebagai variabel Lokal.
Contoh - GET satu data untuk Entity "Documents"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Dokumen dari daftar
Entity. - Pilih operasi
LIST, lalu klik Done. - Untuk menetapkan Klausa Filter, di
bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu
masukkan
Type='envelopes' AND Id='8e18be14-3254-4cbe-947d-f0d1cd62f5f8'di kolom Input Value dan pilih Klausa Filter sebagai Variabel lokal.
Contoh - GET satu data untuk Entity "Envelopes"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Amplop dari daftar
Entity. - Pilih operasi
GET, lalu klik Done. - Untuk menetapkan ID entity, di
bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu
masukkan
8e18be14-3254-4cbe-947d-f0d1cd62f5f87di kolom Input Value dan pilih EntityId sebagai variabel Lokal.
Contoh - GET satu data untuk Entity "Folders"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Folder dari daftar
Entity. - Pilih operasi
GET, lalu klik Done. - Untuk menetapkan ID entity, di
bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu
masukkan
05f76d13-a513-492b-8c58-176702768db0di kolom Input Value dan pilih EntityId sebagai variabel Lokal.
Contoh - GET satu data untuk Entity "Groups"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Grup dari daftar
Entity. - Pilih operasi
GET, lalu klik Done. - Untuk menetapkan ID entity, di
bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu
masukkan
1.4167231E7di kolom Input Value dan pilih EntityId sebagai variabel Lokal.
Contoh - GET satu data untuk Entity "Users"
- Dalam dialog
Configure connector task, klikEntities. - Pilih Users dari daftar
Entity. - Pilih operasi
GET, lalu klik Done. - Untuk menetapkan ID entity, di
bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu
masukkan
16ab549b-95d7-47cb-b557-c2476ef62d9ddi kolom Input Value dan pilih EntityId sebagai variabel Lokal.
Anda juga dapat melakukan operasi GET pada entity berikut:
- UserInfo
- UserSignatures
- Ruang kerja
- Penerima
- AccountBrands
- AccountCustomFields
- EnvelopeTemplates
- EnvelopeAttachments
- EnvelopeConsumerDisclosures
- CloudStorageProviders
- CustomTabs
- Kunci
- GroupBrands
- GroupUsers
- RecipientTabs
- SigningGroups
- SigningGroupUsers
- Template
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 |
|---|---|---|---|
| proxy_enabled | BOOLEAN | Salah | Centang kotak 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 melakukan autentikasi ke proxy ProxyServer. |
| proxy_password | SECRET | Salah | Sandi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. |
Menggunakan koneksi DocuSign dalam integrasi
Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Connectors.
- Untuk memahami cara membuat dan menggunakan tugas Connectors di Apigee Integration, lihat Tugas Connectors.
- Untuk memahami cara membuat dan menggunakan tugas Connectors di Application Integration, lihat Tugas Connectors.
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.