PDF Belgesini Şifrele API
PDF4me Belgeyi Koru Bu, bir PDF dosyasını parola ile koruyan ve alıcıların onunla neler yapabileceğini kısıtlayan bir REST uç noktasıdır. Dosyayı Base64 olarak POST edin. /api/v2/Protect Bir parola ve izin bayrağı ile giriş yapıldığında, yanıt olarak yeni bir AES şifreli PDF dosyası oluşturulur. Yazdırma, kopyalama, düzenleme ve form doldurma işlemleri yalnızca siz izin verdiğiniz takdirde gerçekleştirilebilir.
Bu uç noktanın işlevi
PDF4me Belgeyi Koruyun şifreler PDF Bir parola ile izin bayraklarını tek bir yerde ayarlar. REST Çağrı. Gönder PDF gibi Base64Parolayı ve hangi işlemlerin (yazdırma, kopyalama, not ekleme, form doldurma) izin verildiğini seçin ve yeni bir tane alın. AES-şifrelenmiş PDF Yanıtta. Uygulanan şifreleme şudur: AES-128 veya AES-256 başına PDF özelliklere uygun, şunlar için GDPR, HIPAAve uyumluluk odaklı diğer iş akışları.
Kimliğinizi Doğrulama API Rica etmek
Her PDF4me REST API Çağrınızda mutlaka sizin de bulunmanız gerekiyor. API anahtara girin Authorization Başlık. Geliştirici kontrol panelinden bir anahtar oluşturun veya seçin ve sunucu tarafında tutun. Asla tarayıcı kodunda ifşa etmeyin.
Kaçırmamanız Gereken Önemli Bilgiler
şifre Tarla kapılarının açılış belgesi. pdfİzin `enum`, belge açıldıktan sonra kullanıcıların neler yapabileceğini kontrol eder. İkisini birlikte kullanarak bir belgeyi gönderebilirsiniz. PDF Parola gerektiren VE yazdırma veya kopyalama işlemlerini devre dışı bırakan bir özellik.pdfİzin Engellendi. Ayarlayın. Hiçbiri Açma işlemi dışında her işlemi engellemek veya belirli bir bayrağa (örneğin) odaklanmak. Formları Doldurun Sadece form doldurmaya izin vermek, başka hiçbir şeye izin vermemek.REST API uç nokta
Yöntem: POSTALAMAK
URL: https://api.pdf4me.com/api/v2/Protect
Göndermek İçerik Türü: application/json ve bir Yetkilendirme başlığınızla birlikte API Anahtar. Ayarla. asenkron ile YANLIŞ senkron bir yanıt için (HTTP 200 şifrelenmiş PDF ham ikili baytlar olarak) veya doğru almak için HTTP 202 artı bir Konum 200 değerini döndürene kadar sorguladığınız başlık. PDF.
Postman isteği kurulumu
| Ayar | Değer |
|---|---|
| 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. |
Parametreler
Her zaman gerekli: belge içeriği, belge adı, şifre, pdfİzin. O asenkron bayrak isteğe bağlıdır (varsayılan değer şudur: YANLIŞ) ve yanıtın hemen mi yoksa bir sorgulama URL'si aracılığıyla mı döndürüleceğini kontrol eder.
| Parametre | Gerekli | Tip | Ne işe yarar? | Örnek |
|---|---|---|---|---|
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 |
Hangi pdfPermission bayrağını seçmeliyim?
Parola ve izin bayrağı farklı şeylere karşı koruma sağlar. Parola açılışı kontrol eder; izin bayrağı ise açıldıktan sonra ne olacağını kontrol eder.
| Parola mı yoksa izinler mi? | password alan | pdfPermission alan |
|---|---|---|
| Şunlara karşı koruma sağlar: | Yetkisiz açılış | Açıldıktan sonra istenmeyen işlemler |
| Kimleri etkiliyor? | Şifresi olmayan herkes | Belgeyi açan herkes |
| Tipik kullanım | Gizli teslimat | salt okunur sözleşmeler, prova kopyaları |
| En kısıtlayıcı değer | Güçlü ve benzersiz bir parola | None (sadece açık) |
TümHer şeye izin veriliyor.HiçbiriSadece açılışKopyalaMetni veya görselleri açın ve kopyalayın.Açıklama ekleAçın ve not ekleyinFormları DoldurunForm alanlarını açın ve doldurun.Engellilere DestekErişilebilirlik araçlarıyla açınBir araya getirinSayfa düzeyinde değişikliklere izin verilir.Dijital BaskıSadece düşük çözünürlüklü baskıÖrnekler isteyin
Örnek A: Sadece parola ile şifrele (All izinler)
{
"docContent": "JVBERi0xLjQK...",
"docName": "invoice.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "All",
"async": false
}
Örnek B: Maksimum kısıtlamalarla şifrele (None)
Blok baskı, kopyalama, düzenleme, not ekleme ve form doldurma.
{
"docContent": "JVBERi0xLjQK...",
"docName": "confidential.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "None",
"async": false
}
Örnek C: Şifreleyin ve yalnızca form doldurmaya izin verin.
Alıcının doldurması gereken ancak başkalarına dağıtmaması gereken gizli başvuru formları için kullanışlıdır.
{
"docContent": "JVBERi0xLjQK...",
"docName": "intake-form.pdf",
"password": "Form-2026",
"pdfPermission": "Fill Forms",
"async": true
}
Başarılı yanıt (senkronizasyon, async: false)
HTTP 200 şifrelenmiş PDF ham yanıt gövdesi olarak (ikili) application/pdf). HAYIR JSON Paketleme. Yanıt baytlarını doğrudan bir dosyaya kaydedin.
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="protected.pdf"
<binary PDF bytes>
Başarılı yanıt (eşzamansız, async: true)
HTTP 202 ile Location başlık. Anket URL ile GET (Aynı Authorization (başlık) alana kadar HTTP 200 ikili ile PDF.
HTTP/1.1 202 Accepted
Location: https://api.pdf4me.com/api/v2/JobStatus/<job-id>
curl örnekleri
Senkronizasyon modu (yanıt gövdesini doğrudan bir dosyaya kaydet):
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}'
Asenkron mod (not) -D headers.txt yakalamak için Location (sorgulama için başlık):
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}'
API ne döndürüyor?
Şifrelenmiş belgenin kendisi. Koruma şu şekilde uygulanır: AES şifrelemesi tarafından tanımlandığı gibi PDF spesifikasyonuBu nedenle, standartlara uygun herhangi bir okuyucu parola ister ve izin bayrağını uygular.
| Alan | Tip | İçeriğinde neler var? |
|---|---|---|
| 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. |
Kod örnekleri
Entegrasyon örnekleri
Yaygın REST entegrasyon kalıplarıTypical ways developers call Protect Document.
- Her faturayı okuyun. PDF bir klasörden, S3 kova veya veritabanı kuyruğu.
- Base64-baytları kodla ve POST Korumak için
pdfİzinayarlandıFormları Doldurun. - Yanıt baytlarını doğrudan bir .pdf dosyasına (ham ikili veri) yazın, ardından şifrelenmiş dosyayı e-postaya veya nesne depolama alanına yükleyin.
- Tüm dosyaları döngüyle işleyin. Uç nokta durumsuzdur ve hız limitiniz dahilinde paralel çağrılar için güvenlidir.
- POST kaynak PDF ile
/api/v2/KorumaAlıcı şifresi ve seçilen izin ile. - İkili yanıt baytlarını alın, yeniden kodlayın Base64ve onları besleyin
belge içeriği-e Dijital Tabela uç nokta. - Tek bir tane alın PDF bu ikisi de AES-Şifrelenmiş ve kriptografik olarak imzalanmıştır. Yasal ve uyumluluk gerektiren kullanım durumları için kurcalamaya karşı dayanıklıdır.
- Her alıcı için benzersiz bir parola oluşturun (UUID veya paylaşılan sırdan türetilmiştir).
- POST Bu parolayla korumak için ve
pdfİzinayarlandıHiçbiriKopyalama ve yazdırma işlemlerini tamamen engellemek. - Şifrelenmiş e-postayı gönderin. PDF ve uyumluluk denetim kayıtları için parola ayrı bir kanal üzerinden iletilir.