Panduan Integrasi untuk Menguji Penandatanganan Dokumen Jarak Jauh dengan eSigner CSC API

Panduan ini akan memandu Anda melalui penandatanganan hash dokumen dan file PDF dengan SSL.com penandatangan elektronik layanan penandatanganan cloud dan Cloud Signature Consortium (CSC) API. Semua contoh permintaan API akan ditampilkan dengan Tukang pos, dan kami sarankan untuk menginstal Aplikasi desktop tukang pos di komputer Anda jika Anda ingin mengerjakan contoh. Contoh perintah cURL dari permintaan API juga disertakan.

Panduan ini mencakup penggunaan CSC API di SSL.com Bak pasir pengujian lingkungan, jadi Anda bebas bereksperimen dengan API tanpa khawatir akan ditagih. Silakan lihat kami Panduan kotak pasir untuk petunjuk tentang menyiapkan akun Kotak Pasir Anda.

Jika Anda siap untuk bekerja dengan CSC API di lingkungan eSigner produksi SSLcom, harap baca Penandatanganan Dokumen Jarak Jauh dengan eSigner CSC API.

Buat Pesanan Tes

  1. Pertama, Anda harus membuat perintah penandatanganan dokumen di Sandbox. Mulailah dengan masuk ke akun Sandbox Anda dan pergi ke Menu Utama Tab.
    Dasbor Sandbox
  2. Klik alat pengembang.
    alat pengembang
  3. Pilih Penandatanganan Dokumen eSigner, Lalu klik Buat Urutan Tes .
  4. Kotak dialog akan muncul. Klik OK .
  5. Temukan pesanan pengujian Anda, lalu klik rincian link.
    tautan detail
  6. Klik edit pendaftar untuk mulai memasukkan informasi pemohon dan penerima untuk pesanan tes Anda. Perhatikan bahwa karena informasi ini tidak akan digunakan untuk menerbitkan sertifikat penandatanganan dokumen yang valid, Anda dapat memasukkan informasi fiktif jika diinginkan.
    edit pendaftar
  7. Tambahkan informasi pelamar untuk sertifikat tes, lalu klik Selanjutnya >> .
    Informasi Pemohon
  8. Masukkan informasi penerima, lalu klik Selanjutnya >> .
    Informasi penerima
  9. klik Melewatkan tombol untuk melewati pengunggahan dokumen validasi untuk sertifikat tes.
    Tombol lewati
  10. Pesanan pengujian Anda sekarang harus berstatus validasi tertunda. Hubungi tim dukungan SSL.com di Support@SSL.com agar sertifikat tes Anda divalidasi.
    validasi tertunda

Daftar di eSigner dan Siapkan Autentikasi Dua Faktor

  1. Setelah pesanan pengujian Anda divalidasi oleh staf dukungan SSL.com, Anda dapat mendaftarkannya di eSigner. Arahkan ke Pesanan tab di akun kotak pasir SSL.com Anda dan temukan pesanan pengujian Anda.
    Arahkan ke pesanan
  2. Klik pesanannya rincian link.
    tautan detail
  3. Buat dan konfirmasi 4 digit PIN, lalu klik buat PIN .
    Jika Anda perlu menyetel ulang PIN eSigner Anda, harap baca ini bagaimana caranya.
    Buat PIN
  4. Kode QR akan muncul.
    Lain kali Anda memuat ulang halaman, kode QR tidak akan terlihat. Jika Anda perlu melihat atau mengatur ulang kode QR eSigner Anda, silakan baca ini bagaimana caranya.
    Kode QR
  5. Pindai kode tersebut ke dalam aplikasi otentikasi 2 faktor di perangkat seluler Anda, seperti Google Authenticator atau Authy. Aplikasi ini akan memberi Anda kata sandi satu kali (OTP) untuk digunakan saat menandatangani. Setiap OTP berlaku selama 30 detik.
    OTP di Authy

Install Tukang pos dan Impor Koleksi API CSC

  1. Unduh dan unzip file Koleksi CSC API Postman (Lihat https://www.postman.com/sslcom/workspace/public/collection/3420801-f2df0995-1293-45da-8719-73467c9f0ca7?ctx=documentation untuk titik akhir api atau unduhan koleksi terbaru).
    Koleksi Tukang Pos CSC API
  2. Men-download dan menginstal Klien REST Postman.
    Unduhan Postman REST Client
  3. Luncurkan Postman, lalu buat akun Postman baru atau masuk ke akun yang sudah ada.
    Login Tukang Pos
  4. klik impor .
    Tombol impor
  5. klik Unggah berkas tombol, arahkan ke file koleksi API yang telah dibuka zipnya (CSC-API.postman_collection.json), dan buka.
    Unggah berkas
  6. klik impor .
    Tombol impor
  7. klik koleksi tab di Postman dan perluas koleksi CSC API untuk melihat lima permintaan POST yang akan Anda kerjakan:
    • Info CSC
    • Daftar Kredensial CSC
    • Info Kredensial CSC
    • Otorisasi Kredensial
    • Masuk Hash

    Koleksi CSC API

Ambil Token Akses

  1. Langkah selanjutnya adalah mengambil token akses dari SSL.com. Sebelum Anda meminta token akses, Anda memerlukan ID pelanggan (juga dikenal sebagai ID Aplikasi. Silakan merujuk ke ini bagaimana caranya untuk petunjuk tentang membuat kredensial ini).
  2. Pilih Otorisasi tab, pilih OAuth 2.0 dari Tipe menu, dan klik Dapatkan Token Akses Baru .
    Dapatkan Token Akses Baru
  3. Masukkan informasi berikut ke dalam formulir:
    • Nama Token: SandBox CSC (atau nama lain yang mudah diingat yang Anda sukai)
    • Jenis Hibah: Kode Otorisasi
    • URL Panggilan Balik: [biarkan kosong]
    • Otorisasi menggunakan browser: diperiksa
    • URL Otorisasi: https://oauth-sandbox.ssl.com/oauth2/authorize
    • Akses URL Token: https://oauth-sandbox.ssl.com/oauth2/token
    • ID Klien: [ID Klien Anda]
    • Rahasia Klien: [Rahasia Klien Anda]
    • Cakupan: layanan
    • Negara: [biarkan kosong]
    • Otentikasi Klien: Kirim sebagai header Basic Auth

    Setelah Anda selesai, klik Minta Token .
    Dapatkan token akses baru

  4. Formulir login akan muncul di browser web Anda. Masukkan nama pengguna dan kata sandi SSL.com Anda, lalu klik Login anggota .
    Formulir Login Akun
  5. Token akses baru Anda akan muncul di Postman. Pilih teks token akses dan salin ke clipboard, lalu tutup Kelola Token Akses kotak dialog. Tempel token akses Anda ke editor teks di mana Anda dapat mengaksesnya dengan mudah. Setiap token akses akan kedaluwarsa setelah satu jam.
    Anda juga dapat menyimpan token Anda untuk digunakan kembali di Tukang pos permintaan, tetapi kami menemukan bahwa menyalin dan menempelkan token secara langsung ke setiap permintaan adalah yang paling dapat diandalkan.
    akses Token

Tandatangani Hash

Sekarang setelah Anda memiliki token akses, Anda dapat mulai membuat permintaan API dan membuat tanda tangan. Bagian ini akan memandu Anda melalui lima permintaan yang tersedia di Koleksi CSC tukang pos, menghasilkan pembuatan tanda tangan digital dari hash dokumen.

Dapatkan Info CSC (Opsional)

  1. Anda dapat menggunakan Info CSC meminta untuk mendapatkan informasi tentang layanan tanda tangan cloud SSL.com. Perhatikan bahwa, tidak seperti yang lain dalam koleksi, permintaan ini tidak memerlukan token akses Anda. Untuk mengirim permintaan, pilih Info CSC dari API CSC koleksi, lalu klik Kirim .
    Permintaan Info CSC
  2. Informasi tentang layanan tanda tangan cloud akan muncul di objek JSON di Postman Tanggapan lapangan.
    Info CSC

perintah cURL

curl --location --request POST "https://cs-try.ssl.com/csc/v0/info" \ --header "Jenis Konten: application / json" \ --data-raw "{}"

Daftar Kredensial CSC

  1. Grafik Daftar Kredensial CSC request akan mengambil kredensial yang akan Anda gunakan di permintaan API nanti. Pilih Daftar Kredensial CSC Dan klik Otorisasi Tab.
    Daftar Kredensial CSC
  2. Pilih Token Pembawa dari Tipe menu, tempel token akses Anda ke Token bidang, lalu klik Kirim .
    Tambahkan token dan kirim permintaan
  3. Objek JSON dengan daftar ID kredensial yang terkait dengan pengguna akan muncul di Tanggapan bidang. Daftar Anda mungkin berisi satu nilai. Salin dan tempel ID kredensial Anda ke editor teks untuk digunakan dalam permintaan nanti.
    ID Kredensial

perintah cURL

menggantikan MY-ACCESS-TOKEN dengan token akses Anda yang sebenarnya:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/list" \ --header "Jenis Konten: application / json" \ --header "Otorisasi: Bearer TOKEN-AKSES-SAYA "\ --data-raw" {} "

Jika menggunakan sertifikat eseal (sertifikat penandatanganan dokumen dengan hanya informasi organisasi; disertakan dengan akun esigner.com gratis Anda), maka sertakan "clientData": "DS_ESEAL" (catatan: eseals tidak memerlukan otentikasi OTP). Pilihan lain untuk “clientData” adalah “EVCS” untuk EV Code Signing dan “DS” (default) untuk IV atau IV+OV Document Signing :

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application/json" \ --header "Authorization: Bearer MY-ACCESS-TOKEN" \ --data-raw "{\"clientData\": \"DS_ESEAL\"}"

Info Kredensial CSC (Opsional)

  1. Grafik Info Kredensial CSC request akan mengembalikan sertifikat dan informasi lain yang terkait dengan ID kredensial, dan tidak diperlukan untuk penandatanganan. Untuk menggunakan permintaan ini, pilih Info Kredensial CSC dari koleksi dan klik Otorisasi Tab.
    Info Kredensial CSC
  2. Pilih Token Pembawa dari Tipe menu, lalu tempel token akses Anda ke Token lapangan.
    tempel token otorisasi
  3. Pilih Tubuh tab, lalu tempel ID kredensial Anda sebagai nilainya credentialID.
    Masukkan ID kredensial
  4. klik Kirim .
    Klik tombol kirim
  5. Objek JSON dengan rantai sertifikat penandatanganan Anda dan informasi lainnya akan muncul di Tanggapan lapangan.
    Info ID kredensial

perintah cURL

menggantikan MY-ACCESS-TOKEN dan MY-CREDENTIAL-ID dengan informasi Anda yang sebenarnya:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/info" \ --header "Jenis Konten: application / json" \ --header "Otorisasi: Pembawa SAYA-AKSES-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "certificate \": \ "chain \", \ "certInfo \": true, \ "authInfo \": true} "

Otorisasi Kredensial

  1. Grafik Otorisasi Kredensial permintaan akan mengambil otorisasi untuk menandatangani hash. Mulailah dengan memilih Otorisasi Kredensial dari koleksi dan mengklik Otorisasi Tab.
    Otorisasi Kredensial
  2. Pilih Token Pembawa dari Tipe menu, lalu tempel token akses Anda ke Token lapangan.
    tempel token
  3. Pilih Tubuh tab. Tempel ID kredensial Anda sebagai credentialID nilai dan hash dokumen yang ingin Anda tanda tangani sebagai hash nilai. Ambil dan masukkan OTP dari aplikasi otentikasi Anda dan masukkan sebagai nilainya OTP, Lalu klik Kirim .
    masukkan ID kredensial, hash, dan OTP
  4. Objek JSON dengan Signature Activation Data (SAD) Anda akan muncul di Tanggapan bidang. Salin dan tempel nilai ini ke editor teks untuk digunakan dalam permintaan penandatanganan hash.
    SAD

perintah cURL

menggantikan MY-ACCESS-TOKENMY-CREDENTIAL-ID, MY-HASH, dan MY-OTP dengan informasi Anda yang sebenarnya:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/credentials/authorize" \ --header "Jenis Konten: application / json" \ --header "Otorisasi: Pembawa SAYA-AKSES-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "numSignatures \": 1, \ "hash \": [\ "MY-HASH \ "], \" OTP \ ": \" MY-OTP \ "}"

Masuk Hash

  1. Sekarang kami siap untuk menandatangani hash dokumen. Pilih Masuk Hash dari koleksi, lalu pilih Otorisasi Tab.
    Masuk Hash
  2. Pilih Token Pembawa dari Tipe menu, lalu tempel token akses Anda ke Token lapangan.
    tempel token
  3. Pilih Tubuh tab. Tempel ID kredensial Anda sebagai credentialID nilai, Data Aktivasi Tanda Tangan Anda sebagai SAD nilai, dan hash dokumen yang ingin Anda tanda tangani sebagai hash nilai, lalu klik Kirim .
    Rekatkan SAD dan hash, kirim permintaan
  4. Objek JSON dengan tanda tangan Anda akan muncul di Tanggapan lapangan.
    tanda tangan

perintah cURL

menggantikan MY-ACCESS-TOKENMY-CREDENTIAL-ID, MY-SAD, dan MY-HASH dengan informasi Anda yang sebenarnya:

curl --location --request POST "https://cs-try.ssl.com/csc/v0/signatures/signHash" \ --header "Jenis Konten: application / json" \ --header "Otorisasi: Pembawa SAYA-AKSES-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "SAD \": \ "MY-SAD \", \ "hash \": [\ "MY-HASH \"], \ "signAlgo \": \ "1.2.840.113549.1.1.11 \"} "

Tandatangani PDF

Selain menandatangani hash dokumen, Anda juga dapat mengunggah dan menandatangani file PDF. Mulailah dengan mengunduh dan mengimpor file Koleksi Document Signing API Postman (Lihat https://www.postman.com/sslcom/workspace/public/collection/3454644-277d8427-f749-4a94-93bf-c3478b79b999?ctx=documentation untuk titik akhir api dan unduhan koleksi terbaru), mengikuti yang sama langkah instalasi Anda mengikuti di atas untuk koleksi CSC API.

Otorisasi OTP tidak diperlukan saat penandatanganan menggunakan sertifikat penandatanganan dokumen penyegelan. Abaikan semua parameter OTP dalam panduan berikut jika menggunakan sertifikat penandatanganan dokumen penyegelan. (Pelanggan dengan yang sudah ada Sertifikat penandatanganan dokumen Validasi Organisasi dapat menghubungi support@ssl.com untuk mengubahnya menjadi sertifikat eSealing.)
Saat menandatangani PDF Anda akan bekerja dengan dua permintaan POST:

  • Unggah Dokumen PDF
  • Tanda tangani Dokumen PDF

Koleksi API Penandatanganan Dokumen

Anda dapat menggunakan kembali kredensial yang Anda ambil di atas dengan Daftar Kredensial CSC permintaan. Anda mungkin juga perlu mengambil file token akses.

Unggah Dokumen PDF

  1. Pilih Unggah Dokumen PDF meminta dan klik Otorisasi Tab.
    Unggah Dokumen PDF
  2. Pilih Token Pembawa dari Tipe menu, lalu tempel token akses Anda ke Token lapangan.
    Tempel token
  3. Pilih Header tab dan tempel ID kredensial Anda di Nilai kolom.
    tambahkan ID kredensial ke header
  4. Pilih Tubuh Tab dan klik × sebelah hello.pdf untuk menghapus nama file placeholder ini.
    hapus file placeholder
  5. klik Pilih file tombol, lalu navigasikan ke file yang ingin Anda unggah.
    Pilih file
  6. klik Kirim .
    Kirim permintaan
  7. Pilih dan salin file id nilai dalam respons untuk digunakan dalam permintaan berikutnya.
    ID file

perintah cURL

menggantikan MY-CREDENTIAL-ID, MY-ACCESS-TOKEN, dan /PATH/TO/FILE.pdf dengan informasi Anda yang sebenarnya:

curl --location --request POST "https://ds-try.ssl.com/v1/pdf/upload" \ --header "Credential-Id: MY-CREDENTIAL-ID" \ --header "Otorisasi: Pembawa TOKEN-AKSES-SAYA "\ --header" Jenis-Konten: application / pdf "\ --data-binary" @ / PATH / TO / FILE.pdf "

Catatan: Untuk tanda tangan yang terlihat, silakan lihat Header Permintaan HTTP berikut (/v1/pdf/upload):

Judul Permintaan

Deskripsi Produk

Kredensial-Id

ID Kredensial Unik yang ditetapkan ke kunci – Wajib

Penandatanganan-Alasan

Tambahkan alasan penandatanganan untuk menambahkan tampilan tanda tangan dan juga dalam kamus tanda tangan – Opsional misalnya saya menyetujui dokumen ini

Penandatanganan-Lokasi

Tambahkan lokasi penandatanganan di kamus tanda tangan – Opsional misalnya Houston, Texas

Info kontak

Tambahkan informasi kontak dalam kamus tanda tangan – Opsional misalnya Nomor telepon

Signature-Field-Posisi

Posisi bidang tanda tangan tempat tanda tangan visual ditampilkan. Formatnya adalah "x,y,lebar,tinggi" - Opsional

Nomor halaman

Nomor halaman tempat menggambar tanda tangan – Opsional

Tanda Tangan

Gambar PNG yang disandikan Base64 dari tanda tangan – Opsional




Tanda tangani Dokumen PDF

  1. Sekarang Anda dapat menandatangani PDF. Pilih Unggah Dokumen PDF meminta dan klik Otorisasi Tab.
      
  2. Pilih Token Pembawa dari Tipe menu, lalu tempel token akses Anda ke Token lapangan.
    tempel token
  3. Pilih tab Body, dan tempel di file id nilai dari langkah sebelumnya.
    masukkan ID
  4. Masukkan OTP dari aplikasi otentikasi Anda dan klik Kirim .
    masukkan OTP dan klik Kirim
  5. Data PDF akan muncul di bawah ini di Tanggapan bidang. Memilih Simpan ke File dari Simpan Tanggapan menu, lalu beri nama file.
    Simpan ke file
  6. Buka file di Acrobat untuk mengonfirmasi bahwa file telah ditandatangani. (Perhatikan bahwa pada gambar di bawah ini, akar Pengembangan RSA SSL.com telah dipercaya secara manual di Acrobat.)
    tanda tangan digital di Adobe Acrobat

perintah cURL

menggantikan MY-CREDENTIAL-ID, MY-FILE-ID, dan MY-OTP dengan informasi Anda yang sebenarnya:

curl --location --request POST "https://ds-try.ssl.com/v1/pdf/sign" \ --header "Content-Transfer-Encoding: application / json" \ --header "Jenis Konten : application / json "\ --header" Otorisasi: Pembawa MY-ACCESS-TOKEN "\ --data-raw" {\ "id \": \ "MY-FILE-ID \", \ "otp \": \ "MY-OTP \"} "

 Tayang dengan Produksi

Untuk melakukan siaran langsung, Anda harus menghapus “-try” dari subdomain. Misalnya, untuk menayangkan ds-try.ssl.com, hapus “-try” sehingga subdomain menjadi ds.ssl.com.

Pengguna dapat menandatangani kode dengan kemampuan Extended Validation Code Signing eSigner. Klik di bawah ini untuk informasi lebih lanjut.

PELAJARI LEBIH LANJUT

Twitter
Facebook
LinkedIn
Reddit
Email

Tetap Terinformasi dan Aman

SSL.com adalah pemimpin global dalam keamanan siber, PKI dan sertifikat digital. Daftar untuk menerima berita industri terkini, tips, dan pengumuman produk dari SSL.com.

Kami sangat menantikan tanggapan Anda

Ikuti survei kami dan beri tahu kami pendapat Anda tentang pembelian terakhir Anda.