DocuSign

Gunakan konektor DocuSign untuk melakukan operasi baca di DocuSign.

Sebelum memulai

Sebelum menggunakan konektor DocuSign, lakukan tugas berikut:

• Di 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.viewer
    • roles/secretmanager.secretAccessor

    Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk 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

Untuk mengonfigurasi konektor, Anda harus 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 Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.

   Buka halaman Koneksi

2. Klik + CREATE NEW untuk membuka halaman Create Connection.
3. Di bagian Location, pilih lokasi untuk koneksi.
   1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

   2. Klik NEXT.
4. Di bagian Connection Details, selesaikan tindakan berikut:
   1. Konektor: Pilih DocuSign 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 berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
   4. Secara opsional, masukkan Description untuk instance koneksi.
   5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
   6. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
   7. Secara opsional, pilih UseSandbox jika Anda menggunakan akun sandbox DocuSign.
   8. Secara opsional, konfigurasikan Setelan node koneksi:
      • Jumlah node minimum: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

      Node adalah unit (atau replika) koneksi yang memproses transaksi. Semakin banyak node yang diperlukan untuk memproses lebih banyak transaksi untuk koneksi, dan sebaliknya, semakin sedikit node yang diperlukan untuk memproses lebih sedikit transaksi. 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.

   Catatan: Anda hanya dapat menyesuaikan nilai node koneksi jika merupakan pelanggan Bayar sesuai penggunaan.
   9. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
   10. Klik NEXT.
5. Di bagian Authentication, masukkan detail autentikasi.
   1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh koneksi DocuSign:

      • OAUTH 2.0 - Kode Otorisasi
      • OAuth 2.0 - Bearer JWT

   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.

• OAUTH 2.0 - Authorization Code
  • Client ID: Client ID yang digunakan untuk meminta token akses.
  • Cakupan: Daftar cakupan yang diinginkan yang dipisahkan koma.
  • Rahasia Klien: Secret Manager Secret yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
• OAuth 2.0 - JWT Bearer
  • Kunci Konsumen Aplikasi Terhubung:Kunci konsumen yang disediakan untuk aplikasi terhubung yang Anda buat.
  • Nama pengguna: Nama pengguna yang terkait dengan aplikasi terhubung yang Anda buat.
  • Kunci Pribadi: Secret Pengelola Secret yang berisi konten file kunci pribadi. Kunci pribadi harus cocok dengan kunci publik/sertifikat yang diberikan ke Konektor.

Contoh konfigurasi koneksi

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

OAUTH 2.0 - Jenis koneksi Kode Otorisasi

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	[e-mail]
Autentikasi	OAuth 2.0 - Kode otorisasi
ID klien	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Cakupan	tanda tangan
Rahasia klien	CLIENT_SECRET
Versi Secret	1

OAuth 2.0 - Jenis koneksi Bearer JWT

Nama kolom	Detail
Lokasi	us-central1
Konektor	DocuSign
Versi konektor	1
Nama Koneksi	gcp-docusign-token
Mengaktifkan Cloud Logging	Tidak
UseSandbox	Ya
Akun Layanan	[e-mail]
Autentikasi	OAuth 2.0 - Bearer JWT
Kunci Pengguna Connected App	67dxxxxx-xxxx-xxxx-xxxx-xxxxxxxcb79
Nama pengguna	USER_NAME
Kunci Pribadi	PRIVATE_KEY
Versi Secret	1

Entity, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

Catatan: Anda dapat melihat entity, operasi, dan tindakan konektor di tugas Konektor.

• Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, dalam konektor database, tabel adalah entitas, dalam konektor server file, folder adalah entitas, dan dalam konektor sistem pesan, antrean adalah entitas.

  Namun, mungkin konektor tidak mendukung atau memiliki entity apa pun, 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 entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar Operations.

• Tindakan: Tindakan adalah fungsi kelas satu 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. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, konektor mungkin tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Catatan: Semua entitas dan tindakan akan memiliki skema yang terkait dengannya. Misalnya, skema tindakan akan memiliki detail parameter seperti; nama parameter, dan jenis data yang sesuai. Skema (metadata) untuk entity dan tindakan diambil oleh koneksi saat runtime dari backend Anda. Jika ada pembaruan pada skema, pembaruan tersebut tidak akan otomatis ditampilkan di koneksi yang ada; Anda harus memuat ulang skema secara manual. Untuk memuat ulang skema koneksi, buka halaman Connection details koneksi, lalu klik Refresh connection schema.

Batasan sistem

Konektor DocuSign dapat memproses 3 transaksi per detik, per node, dan mencegah transaksi apa pun melampaui batas ini. Secara default, Konektor Integrasi mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

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

Catatan: Jumlah node Konektor Integrasi akan diskalakan secara 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. Diperlukan lebih banyak node untuk memproses lebih banyak transaksi untuk koneksi. Sebaliknya, lebih sedikit node yang diperlukan jika koneksi memproses lebih sedikit transaksi. Untuk mengonfigurasi nilai node, lakukan hal berikut:

• Jika Anda adalah pelanggan bayar sesuai penggunaan, konfigurasikan nilai node minimum dan maksimum di halaman edit koneksi.
• Jika Anda adalah pelanggan 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 disiapkan secara optimal untuk menangani traffic yang diperlukan.

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"

1. Pada 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.

Contoh - Operasi LIST untuk Entity "Documents"

1. Pada 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.

Contoh - Operasi LIST untuk Entity "Envelopes"

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

Contoh - Operasi LIST untuk Entity "Folder"

1. Pada 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.

Contoh - Operasi LIST untuk Entitas "Grup"

1. Pada 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.

Contoh - Operasi LIST untuk Entity "Users"

1. Pada 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 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 data untuk Entitas "Akun"

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Akun dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menetapkan ID entitas, di bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu masukkan 2.4578824E7 di kolom Input Value dan pilih EntityId sebagai variabel Lokal.

Contoh - GET satu data untuk Entitas "Dokumen"

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Dokumen dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Untuk menetapkan Klausa Filter, di bagian Data Mapper pada Pemetaan Data, 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 - Mendapatkan satu data untuk Entitas "Envelopes"

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Envelop dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menetapkan ID entitas, di bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu masukkan 8e18be14-3254-4cbe-947d-f0d1cd62f5f87 di kolom Input Value dan pilih EntityId sebagai variabel Lokal.

Contoh - Mendapatkan satu data untuk Entitas "Folder"

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Folder dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menetapkan ID entitas, di bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu masukkan 05f76d13-a513-492b-8c58-176702768db0 di kolom Input Value dan pilih EntityId sebagai variabel Lokal.

Contoh - GET satu data untuk "Grup" Entitas

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Grup dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menetapkan ID entitas, di bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu masukkan 1.4167231E7 di kolom Input Value dan pilih EntityId sebagai variabel Lokal.

Contoh - Mendapatkan satu data GET untuk Entity "Users"

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Pengguna dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Untuk menetapkan ID entitas, di bagian Data Mapper pada Data Mapping, klik Open Data Mapping Editor, lalu masukkan 16ab549b-95d7-47cb-b557-c2476ef62d9d di kolom Input Value 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

Menggunakan 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	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 mengautentikasi ke proxy ProxyServer.
proxy_password	SECRET	Salah	Sandi yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer.

Menggunakan koneksi DocuSign dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. 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.

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.

Langkah selanjutnya

• Pahami cara menangguhkan dan melanjutkan koneksi.
• Pahami cara memantau penggunaan konektor.
• Pahami cara melihat log konektor.