Enkripsi Dokumen PDF API
PDF4me Lindungi Dokumen adalah endpoint REST yang melindungi PDF dengan kata sandi dan membatasi apa yang dapat dilakukan penerima terhadapnya. Kirim file tersebut sebagai Base64 ke /api/v2/Protect Dengan kata sandi dan flag izin, dan responsnya adalah PDF baru yang dienkripsi AES. Pencetakan, penyalinan, pengeditan, dan pengisian formulir hanya diperbolehkan jika Anda mengizinkannya.
Fungsi dari endpoint ini
PDF4me Lindungi Dokumen mengenkripsi sebuah PDF dengan kata sandi dan mengatur bendera izin dalam satu REST Telepon. Kirim PDF sebagai Base64, pilih kata sandi dan tindakan mana yang diizinkan (mencetak, menyalin, memberi anotasi, mengisi formulir), dan terima yang baru AES-terenkripsi PDF dalam respons. Enkripsi yang diterapkan adalah AES-128 atau AES-256 menurut PDF spesifikasi, cocok untuk GDPR, HIPAAdan alur kerja berbasis kepatuhan lainnya.
Memverifikasi Identitas Anda API Meminta
Setiap PDF4me REST API panggilan harus menyertakan Anda API kunci di Authorization header. Buat atau pilih kunci dari dasbor pengembang dan simpan di sisi server. Jangan pernah mengeksposnya dalam kode browser.
Fakta Penting yang Tidak Boleh Anda Lewatkan
kata sandi Pembukaan dokumen gerbang lapangan. Itu Izin PDF Enum mengontrol apa yang dapat dilakukan pengguna setelah dokumen dibuka. Gunakan keduanya bersama-sama untuk mengirimkan sebuah PDF yang memerlukan kata sandi DAN menonaktifkan pencetakan atau penyalinan.Izin PDF diblokir. Atur ke Tidak ada untuk memblokir setiap tindakan kecuali membuka, atau ke bendera tertentu seperti Isi Formulir hanya mengizinkan pengisian formulir dan tidak ada yang lain.REST API titik akhir
Metode: POS
URL: https://api.pdf4me.com/api/v2/Protect
Mengirim Content-Type: application/json dan sebuah Otorisasi header dengan milik Anda API kunci. Atur asinkron ke PALSU untuk respons sinkron (HTTP 200 dengan yang terenkripsi PDF sebagai byte biner mentah), atau BENAR untuk menerima HTTP 202 ditambah a Lokasi header yang Anda periksa terus-menerus hingga mengembalikan kode 200 dengan nilai biner. PDF.
Pengaturan permintaan Postman
| Pengaturan | Nilai |
|---|---|
| Method | POST |
| URL | https://api.pdf4me.com/api/v2/Protect |
| Headers | Content-Type: application/json |
| Authorization | Basic Auth with your API key, or header Authorization: Basic YOUR_API_KEY |
| Body | raw JSON with docContent, docName, password, pdfPermission, and async fields |
| Response (sync) | When async is false: HTTP 200 with the encrypted PDF as raw binary bytes. Save the response body directly to a .pdf file. |
| Response (async) | When async is true: HTTP 202 with a Location header. GET that URL until you receive 200 plus the binary PDF. Useful for large files or slow networks. |
Parameter
Selalu diperlukan: Konten dokumen, Nama dokumen, kata sandi, Izin PDF. Itu asinkron flag bersifat opsional (nilai defaultnya adalah PALSU) dan mengontrol apakah respons dikembalikan segera atau melalui URL polling.
| Parameter | Diperlukan | Jenis | Apa fungsinya? | Contoh |
|---|---|---|---|---|
docContent | Required | Base64 String | The source PDF file encoded as Base64 (no data: prefix). Read the file as bytes and run it through your language's Base64 encoder. | JVBERi0xLjQK... |
docName | Required | String | Filename of the source PDF including the .pdf extension. Used for tracking and the output filename. | invoice.pdf |
password | Required | String | The password applied to the encrypted PDF. Users must enter this to open the document. | Str0ng-P@ss! |
pdfPermission | Required | Enum | What the user can do once the PDF is unlocked. One of: All, None, Copy, Annotate, Fill Forms, Support Disabilities, Assemble, Digital Print. See the flag reference card grid below. | Fill Forms |
async | Optional | Boolean | Defaults to false. When false the API returns the encrypted PDF immediately as binary bytes (HTTP 200). When true the API returns HTTP 202 with a Location header; poll that URL with GET until you receive 200 with the binary PDF. Use true for large PDFs or batch processing. | false |
Bendera pdfPermission mana yang harus saya pilih?
Kata sandi dan flag izin melindungi dari hal yang berbeda. Kata sandi mengatur pembukaan gerbang; flag izin mengatur apa yang terjadi setelah pembukaan.
| Kata sandi vs izin | password bidang | pdfPermission bidang |
|---|---|---|
| Melindungi terhadap | Pembukaan tanpa izin | Tindakan yang tidak diinginkan setelah pembukaan |
| Siapa yang terdampak | Semua orang tanpa kata sandi | Semua orang yang membuka dokumen tersebut |
| Penggunaan umum | Pengiriman rahasia | Kontrak hanya baca, salinan bukti |
| Nilai paling ketat | Kata sandi unik yang kuat | None (hanya buka) |
SemuaSegala sesuatu diperbolehkan.Tidak adaHanya bukaMenyalinBuka dan salin teks atau gambar.Membubuhi keteranganBuka dan beri anotasiIsi FormulirBuka dan isi kolom formulir.Dukungan bagi Penyandang DisabilitasBuka dengan alat aksesibilitasBerkumpulPerubahan tingkat halaman diperbolehkanCetak DigitalHanya cetakan resolusi rendahMinta contoh
Contoh A: Enkripsi hanya dengan kata sandi (All izin)
{
"docContent": "JVBERi0xLjQK...",
"docName": "invoice.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "All",
"async": false
}
Contoh B: Enkripsi dengan batasan maksimum (None)
Mencetak, menyalin, mengedit, memberi anotasi, dan mengisi formulir.
{
"docContent": "JVBERi0xLjQK...",
"docName": "confidential.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "None",
"async": false
}
Contoh C: Enkripsi dan hanya izinkan pengisian formulir
Berguna untuk formulir penerimaan informasi rahasia di mana penerima harus mengisi tetapi tidak boleh mendistribusikannya kembali.
{
"docContent": "JVBERi0xLjQK...",
"docName": "intake-form.pdf",
"password": "Form-2026",
"pdfPermission": "Fill Forms",
"async": true
}
Respons berhasil (sinkronisasi, async: false)
HTTP 200 dengan yang terenkripsi PDF sebagai badan respons mentah (biner) application/pdf). TIDAK JSON pembungkus. Simpan byte respons langsung ke file.
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="protected.pdf"
<binary PDF bytes>
Respons berhasil (asinkron, async: true)
HTTP 202 dengan sebuah Location Judul. Lakukan jajak pendapat tentang itu. URL dengan GET (sama Authorization header) sampai Anda menerima HTTP 200 dengan biner PDF.
HTTP/1.1 202 Accepted
Location: https://api.pdf4me.com/api/v2/JobStatus/<job-id>
contoh curl
Mode sinkronisasi (simpan isi respons langsung ke file):
curl -X POST https://api.pdf4me.com/api/v2/Protect \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-o protected.pdf \
-d '{"docContent":"JVBERi0xLjQK...","docName":"invoice.pdf","password":"Str0ng-P@ss!","pdfPermission":"Fill Forms","async":false}'
Mode asinkron (catatan) -D headers.txt untuk menangkap Location (header untuk polling):
curl -X POST https://api.pdf4me.com/api/v2/Protect \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-D headers.txt \
-d '{"docContent":"...","docName":"invoice.pdf","password":"Str0ng-P@ss!","pdfPermission":"Fill Forms","async":true}'
Apa yang dikembalikan oleh API?
Dokumen terenkripsi itu sendiri. Perlindungan diterapkan dengan Enkripsi AES sebagaimana didefinisikan oleh Spesifikasi PDF, sehingga setiap pembaca yang sesuai standar akan meminta kata sandi dan memberlakukan flag izin.
| Bidang | Jenis | Isi di dalamnya |
|---|---|---|
| Response body (HTTP 200) | Binary | The encrypted PDF bytes (Content-Type application/pdf). Write them straight to a new .pdf file; the source file is never modified. |
| Location header (HTTP 202) | String (URL) | Returned when async is true and processing continues in the background. GET this URL with the same Authorization header. |
| Poll response (HTTP 200) | Binary | The finished encrypted PDF, returned once the async job completes. |
| Poll response (HTTP 202) | Empty | Job still processing. Wait and poll the same Location URL again. |
Contoh kode
Contoh integrasi
Pola integrasi REST umumTypical ways developers call Protect Document.
- Bacalah setiap faktur PDF dari sebuah folder, S3 bucket, atau antrian basis data.
- Base64-mengenkode byte dan POST untuk Melindungi dengan
Izin PDFdiatur keIsi Formulir. - Tulis byte respons langsung ke file .pdf (biner mentah), lalu unggah file terenkripsi tersebut ke email atau penyimpanan objek.
- Lakukan perulangan pada setiap file. Endpoint bersifat stateless dan aman untuk panggilan paralel dalam batas laju yang Anda tetapkan.
- POST sumber PDF ke
/api/v2/Protectdengan kata sandi penerima dan izin yang dipilih. - Ambil byte respons biner, encode ulang menjadi Base64dan memberi mereka makan sebagai
Konten dokumenke Tanda Tangan Digital titik akhir. - Menerima satu PDF itu keduanya AES-Terenkripsi dan ditandatangani secara kriptografis. Tahan terhadap perubahan untuk keperluan hukum dan kepatuhan.
- Buat kata sandi unik untuk setiap penerima (UUID atau yang berasal dari rahasia bersama).
- POST untuk melindungi dengan kata sandi tersebut dan
Izin PDFdiatur keTidak adauntuk memblokir semua penyalinan dan pencetakan. - Kirimkan email yang terenkripsi PDF dan kata sandi melalui saluran terpisah untuk jejak audit kepatuhan.