Güvenli Belge - Belge Güvenliği API
PDF4me Güvenli Belge Bu özellik, kapsamlı güvenlik kontrolleri ve düzenleme kısıtlamalarıyla Word belgelerine parola koruması ve güvenlik kısıtlamaları eklemenizi sağlar. API Bu hizmet, Word dosyalarını işler ve açık parola koruması, belge düzenleme kısıtlamaları, salt okunur koruma, yalnızca yorum erişimi, form alanı düzenleme ve revizyon takibi uygular. API Word belgesi içeriğini şu yolla alır: REST API aramalar, kullanarak Base64 Güvenli iletim için kodlama. Güvenlik seviyeleri ve parola gereksinimleri üzerinde tam kontrol sağlayan bu çözüm, gizli belgeler, ortak düzenleme ve belge erişim kontrolü iş akışları için idealdir.
Kimliğinizi Doğrulama API Rica etmek
Erişmek için PDF4me REST APIHer istek, geçerli kimlik doğrulama bilgilerini içermelidir. Kimlik doğrulama, güvenli iletişimi sağlar ve yetkili bir kullanıcı olarak kimliğinizi doğrular. REST API.
Başlıca Özellikler
- Parola KorumasıBelgeleri açmak için parola gereksinimi ekleyin.
- Belge KorumasıÇeşitli koruma türleriyle düzenleme yeteneklerini kısıtlayın.
- Salt Okuma GüvenliğiBelgeleri yetkisiz düzenlemeyi önlemek için salt okunur hale getirin.
- Yalnızca Yorumlara ErişimYalnızca yorumların eklenmesine veya değiştirilmesine izin ver.
- Form Alanı DüzenlemeDüzenlemeyi yalnızca form alanlarıyla sınırlandırın.
- Revizyon TakibiYalnızca izlenen değişikliklere ve revizyonlara izin ver
- Birleşik GüvenlikHem parola korumasını hem de düzenleme kısıtlamalarını uygulayın.
- Esnek Erişim KontrolüFarklı kullanım durumları için farklı güvenlik seviyeleri.
REST API Uç nokta
O PDF4me REST API standart kullanır HTTP Kaynaklarla etkileşim kurma yöntemleri. Tüm belge güvenliği işlemleri tek bir uç nokta üzerinden gerçekleştirilir:
- Yöntem: POST
- Uç nokta:
office/ApiV2Word/ApplySecurity
REST API Parametreler
Güvenli Belge için parametrelerin tam listesi REST APIParametreler, daha iyi anlaşılması ve uygulanması için kategoriye göre düzenlenmiştir.
Önemli: Yıldız (*) ile işaretlenmiş parametreler zorunludur. Parola parametreleri, ilgili güvenlik seçenekleri etkinleştirildiğinde zorunludur.
Gerekli Parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| belge* | Object | Belge referansı. İçermelidir. İsim (string): .docx uzantılı Word dosya adı | { "Name": "document.docx" } |
| belge içeriği* | Base64 | Word belgesinin içeriği kodlanmıştır. Base64Bu belgeye güvenlik ayarları uygulanmıştır. Geçerli bir Word belgesi olmalıdır (.docx, .doc formatları). | base64EncodedDocumentContent |
İsteğe Bağlı Parametreler (Güvenlik Ayarları)
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| secureOnOpen | String | Belgeyi açmak için parola korumasını etkinleştirin. "yes" = Açmak için parola gereklidir. "no" = Açmak için parola gerekmez (varsayılan). Gereklidir secureOnOpenPassword etkinleştirildiğinde | "yes" |
| secureOnOpenPassword | String | Belgeyi açmak için parola gereklidir. Parola şu durumlarda gereklidir: secureOnOpen dır "yes"Güçlü bir parola kullanın (8 karakterden fazla). Büyük/küçük harf duyarlı olmalıdır. | "SecurePass123!" |
| Güvenlik Seçenekleri | Object | Belge koruma seçenekleri. Özellikler: korumaTipi (string: NoProtection, ReadOnly, AllowComments, AllowFormFields, AllowRevisions), korumaŞifresi (string). protectionType "NoProtection" olmadığında gereklidir. | { "protectionType": "ReadOnly", "protectionPassword": "EditPass456!" } |
Koruma Türü Seçenekleri
O API Belge düzenleme kısıtlamaları için farklı koruma türleri sunar:
| Koruma Türü | Tanım | Kullanım Durumu |
|---|---|---|
| NoProtection | Düzenleme kısıtlaması yok (varsayılan) | Serbestçe düzenlenebilen belgeler |
| ReadOnly | Belge düzenlenemez, yalnızca görüntülenebilir. | Son belgeler, yayınlanmış raporlar |
| AllowComments | Yalnızca yorumlar eklenebilir/değiştirilebilir. | Belge inceleme iş akışları |
| AllowFormFields | Yalnızca form alanları düzenlenebilir. | Doldurulabilir formlar, anketler |
| AllowRevisions | Yalnızca izlenen değişikliklere/revizyonlara izin verilir. | Değişiklik takibi ile ortak düzenleme |
Güvenlik Yapılandırması
Parola Koruması (Açık Parola)
- AmaçBelgeyi açmak için parola gereklidir.
- Ne zaman kullanılır?Gizli belgeler, hassas bilgiler
- Gereklilik:
secureOnOpenPasswordsağlanmalıdırsecureOnOpendır"yes" - KuvvetÖnerilen karakter sayısı: Alfanümerik ve özel karakterler dahil olmak üzere en az 8 karakter.
Belge Koruması (Düzenleme Kısıtlamaları)
- AmaçDüzenleme özelliklerini kısıtlarken belge görüntülemeye izin verir.
- Ne zaman kullanılır?: İşbirliğine dayalı düzenleme, form dağıtımı, inceleme iş akışları
- Gereklilik:
securityOptions.protectionPasswordsağlanmalıdırsecurityOptions.protectionType"Koruma Yok" değildir. - EsneklikÇift katmanlı güvenlik için açık parola ile birlikte kullanılabilir.
Çıktı
O PDF4me Güvenli Belge REST API İşleme moduna bağlı olarak farklı yanıtlar döndürür. API Word belgesini şu şekilde döndürür: Base64-kodlanmış dize içinde JSON formatİkili veri olarak değil.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Senkron İşleme (Varsayılan)
O API İsteği işler ve geri döner:
Durum Kodu: 200 OK
İçerik Türü: application/json
Yanıt Metni:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
Yanıt Alanları:
- belge (string): Güvenlik ayarları uygulanmış Word belgesi, şu şekilde kodlanmıştır: Base64 sicim
- dosya adı (string): Çıktı Word dosyasının adı
- başarı (boolean): İsteğin başarılı olup olmadığını gösterir.
- hataMesajı (string veya boş): Başarı başarısız olduğunda hata ayrıntıları
Kullanım Talimatları:
- Çıkarın
documenttarladan JSON cevap (Base64) - Şifreyi çöz Base64 Word belgesinin ikili verilerini almak için kullanılan dize
- Word dosyasını gerektiği gibi kaydedin veya işleyin.
- Belge, Word'de açıldığında güvenlik ayarlarına bağlı olarak parola(lar) gerektirecektir.
Örnek (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes - document is password protected
Asenkron İşleme
Asenkron davranış (202) Accepted (Yoklama ile birlikte) bu özellik, istek gövdesi parametresiyle değil, sunucu yapılandırmasıyla kontrol edilir. Etkinleştirildiğinde, API yoklama işlemiyle 202 durum kodu döndürebilir. URL içinde Location başlık. Sorgula URL ile GET 200 talep alana kadar OK Aynı yanıt biçimiyle (belge, dosya adı, başarı, hata mesajı).
Hata Yanıtları
O API standart iadeler HTTP Hata kodları ve hata detayları:
- Geçersiz istek parametreleri
- Gerekli alanlar eksik (
belgeileİsim,belge içeriği) - Şifre gereklidir.
secureOnOpen"Evet"tir (secureOnOpenPassword) - Güvenlik şifresi gereklidir.
Güvenlik SeçenekleriprotectionType "NoProtection" olmadığında - Geçersiz Base64 kodlamada
belge içeriği - Geçersiz veya bozuk Word belgesi
- Geçersiz koruma türü
- Zayıf parola (8 karakterden kısa olması önerilir)
- Geçersiz veya eksik API anahtar
- API anahtar düzgün değil Base64 kodlanmış Authorization başlık
- Eksik
Yetkilendirme: Temelbaşlık
- Sunucu tarafı işlem hatası
- Word belgesi işleme hatası
- Güvenlik ayarları uygulanırken hata oluştu.
- Bytes'tan belge yüklenirken hata oluştu.
Hata Yanıtı Biçimi:
{
"error": "Error message describing what went wrong"
}
Yanıt Biçimi Ayrıntıları
Önemli: O API her zaman geri döner JSONAsla ikili Word verilerini doğrudan kullanmayın.
Yanıt Yapısı:
{
"document": "string", // Base64-encoded Word document with security applied
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}
İçerik Türü Başlığı:
- Başarı:
application/json - Word belgesi şu şekilde yerleştirilmiştir: Base64 dize içinde JSON cevap
Neden Base64?
- JSON-ikili veriler için güvenli kodlama
- İletilmesi kolay HTTP
- Tüm programlama dilleriyle uyumludur.
- Doğrudan içine yerleştirilebilir JSON sorunlardan kaçmadan
Kod çözme Base64 Word Belgesine:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.docx", wordBytes);
Talep Örneği
Başlık
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Not:
- Alın API anahtardan PDF4me Kontrol Paneli
- O API anahtar olmalı Base64 "Basic" önekiyle kodlanmış ve ön eklenmiş Authorization başlık
- Örnek: Eğer sizin API anahtar şudur
abc123onu kodla Base64 ve kullanınAuthorization: Basic YWJjMTIz
Yük
Temel Örnek (Sadece Parola Koruması):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"secureOnOpen": "yes",
"secureOnOpenPassword": "SecurePass123!"
}
Gelişmiş Örnek (Parola + Salt Okuma Koruması):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"secureOnOpen": "yes",
"secureOnOpenPassword": "SecurePass123!",
"securityOptions": {
"protectionType": "ReadOnly",
"protectionPassword": "EditPass456!"
}
}
Yalnızca Yorum Koruması Örneği:
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"secureOnOpen": "no",
"securityOptions": {
"protectionType": "AllowComments",
"protectionPassword": "ReviewPass789!"
}
}
Form Alanı Koruma Örneği:
{
"document": { "Name": "form.docx" },
"docContent": "base64EncodedDocumentContent",
"secureOnOpen": "no",
"securityOptions": {
"protectionType": "AllowFormFields",
"protectionPassword": "FormPass2024!"
}
}
Kod Örnekleri
O PDF4me Güvenli Belge REST API Birden fazla programlama dilinde kod örnekleri sunar. Geliştirme ortamınıza en uygun dili seçin:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Örnek
Tamamlamak C# Word belgelerinin güvenliğini sağlamaya yönelik uygulama:
Google Script Örnek
Google Apps Script uygulama için Google Workspace entegrasyon:
Sektör Kullanım Örnekleri ve Uygulamaları
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Hukuk ve Profesyonel Hizmetler Kullanım Örnekleri
- Gizli Müşteri BelgeleriHassas hukuki belgelere parola koruması uygulayın.
- Sözleşme GüvenliğiMüşteri incelemesi için salt okunur korumaya sahip güvenli sözleşmeler.
- Yasal Form Dağıtımı: Yasal formlara form alanı koruması uygulayın
- Belge İncelemesiHukuki belge incelemesi için yalnızca yorum korumasını kullanın.
İşletme ve Kurumsal Kullanım Senaryoları
- Teklif GüvenliğiGizli tekliflere parola koruması uygulayın.
- Müşteri Belge İncelemesiMüşteri belgesi incelemesi için yalnızca yorum korumasını kullanın.
- Pazarlama Formu DağıtımıPazarlama formlarına form alanı koruması uygulayın.
- Satış Belgesi İşbirliğiSatış belgesi düzenlemesi için revizyon korumasını kullanın.
Eğitim ve Araştırma Kullanım Örnekleri
- Hasta Belge GüvenliğiHastaya ait gizli belgelere parola koruması uygulayın.
- Tıbbi Rapor Koruması: Sadece okunabilir koruma ile güvenli tıbbi raporlar
- Araştırma Belgesi İşbirliğiAraştırma belgesi düzenlemesi için revizyon korumasını kullanın.
- Akademik ve Kurumsal BelgelerDers programlarını, hibeleri ve kurum içi belgeleri güvenli bir şekilde saklayın.
Finans ve Bankacılık Kullanım Örnekleri
- Finansal Rapor GüvenliğiGizli finansal raporlara parola koruması uygulayın.
- Denetim Belgesi KorumasıDenetim belgelerini salt okunur koruma ile güvenli hale getirin.
- Bütçe Formu DağıtımıBütçe formlarına form alanı koruması uygulayın.
- Uyumluluk BelgeleriUyumluluk belgesi düzenlemesi için revizyon korumasını kullanın.