Belgeleri Karşılaştır - Belge Karşılaştırması API
PDF4me Belgeleri Karşılaştır Bu özellik, iki Word belgesini karşılaştırmanıza ve kapsamlı karşılaştırma seçenekleriyle değişiklikleri izlemenize olanak tanır. API Bu servis, iki Word dosyasını işler ve ayrıntılı değişiklik takibi, özelleştirilebilir karşılaştırma ayarları, revizyon yönetimi ve profesyonel karşılaştırma raporları içeren bir karşılaştırma belgesi oluşturur. API hem belge içeriklerini hem de şu yollarla alır REST API aramalar, kullanarak Base64 Güvenli iletim için kodlama. Biçimlendirme, büyük/küçük harf duyarlılığı, yorumlar, tablolar, alanlar, dipnotlar, metin kutuları ve üstbilgiler/altbilgiler üzerinde tam kontrol sağlayan bu çözüm, belge incelemesi, sürüm kontrolü ve işbirlikçi düzenleme 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
- Belge Karşılaştırmasıİki Word belgesini karşılaştırın ve tüm farklılıkları belirleyin.
- Değişiklikleri İzleDeğişiklikleri gösteren ve izlenen değişiklikler içeren belgeler oluşturun.
- Özelleştirilebilir SeçeneklerHangi tür değişikliklerin izleneceğini veya göz ardı edileceğini kontrol edin.
- Revizyon YönetimiKarşılaştırmadan önce mevcut revizyonları temizleyin.
- Yazar AtıfıDeğişikliklerin sorumluluğunu belirli yazarlara atayın.
- Profesyonel ÇıktıRevizyon takibi özelliğiyle temiz karşılaştırma belgeleri oluşturun.
- Çoklu Biçim Desteği: .docx ve .doc dosyalarını karşılaştırın
- Gelişmiş FiltrelemeBiçimlendirmeyi, büyük/küçük harf değişikliklerini, yorumları, tabloları ve daha fazlasını göz ardı edin.
REST API Uç nokta
O PDF4me REST API standart kullanır HTTP Kaynaklarla etkileşim kurma yöntemleri. Tüm belge karşılaştırma işlemleri tek bir uç nokta üzerinden gerçekleştirilir:
- Yöntem: POST
- Uç nokta:
office/ApiV2Word/CompareDocuments
REST API Parametreler
Belgeleri Karşılaştır 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 ve mutlaka sağlanmalıdır. API doğru şekilde çalışması için.
Gerekli Parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| ilkBelge* | Object | İlk (temel) belge referansı. İçermelidir. İsim (dize): Uzantısı (.docx, .doc) olan belge adı. Bu belge karşılaştırma için temel teşkil eder. | { "Name": "original.docx" } |
| ilkBelgeİçeriği* | Base64 | Base64-İlk belgenin kodlanmış içeriği. Geçerli bir Word belgesi olmalıdır (.docx, .doc formatları). | UEsDBBQABgAIAAAA... |
| ikinciBelge* | Object | İkinci (karşılaştırma) belge referansı. İçermelidir. İsim (dize): Uzantısı (.docx, .doc) olan belge adı. Bu belge ilk belgeyle karşılaştırılır. | { "Name": "modified.docx" } |
| ikinciBelgeİçeriği* | Base64 | Base64-İkinci belgenin kodlanmış içeriği. Geçerli bir Word belgesi olmalıdır (.docx, .doc formatları). | UEsDBBQABgAIAAAA... |
İsteğe Bağlı Parametreler (Karşılaştırma Seçenekleri)
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| karşılaştırmaSeçenekleri | Object | Karşılaştırma ayarları. Özellikler: Biçimlendirmeyi yok say (mantıksal), Büyük/küçük harf değişikliklerini yok say (mantıksal), Yorumları yok say (mantıksal), Tabloları yok say (mantıksal), alanları yok say (mantıksal), Dipnotları yok say (mantıksal), Metin kutularını yok say (mantıksal), Başlıkları ve altbilgileri yok say (mantıksal), yazar (dize). Aşağıdaki Karşılaştırma Seçeneklerine bakın. | { "ignoreFormatting": false, "author": "John Doe" } |
Karşılaştırma Seçenekleri
O API Hangi değişikliklerin izleneceğine dair ayrıntılı kontrol sağlar:
İçerik Seçenekleri:
- Biçimlendirmeyi yok sayMetin içeriğine odaklanın, stil değişikliklerini göz ardı edin.
- Büyük/küçük harf değişikliklerini yok sayBüyük/küçük harf duyarlılığı olmayan karşılaştırma
- Yorumları yok sayYorumlardaki değişiklikleri karşılaştırmadan hariç tut
- Tabloları yok sayTablo yapısı ve içerik değişikliklerini hariç tut
- alanları yok sayAlan güncellemelerini (otomatik güncellenen içeriği) hariç tut
Belge Öğesi Seçenekleri:
- Dipnotları yok sayDipnot değişikliklerini hariç tut
- Metin kutularını yok sayMetin kutusu değişikliklerini hariç tut
- Başlıkları ve altbilgileri yok sayBaşlık/altbilgi değişikliklerini hariç tut
Kaynak gösterimi:
- yazarKarşılaştırma belgesinde izlenen değişiklikler için yazar adını ayarlayın.
Çıktı
O PDF4me Belgeleri Karşılaştır 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 Tamam
İçerik Türü: application/json
Yanıt Metni:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "comparison-result.docx",
"success": true,
"errorMessage": null
}
Yanıt Alanları:
- belge (dize): Değişiklik izleme özelliğiyle tüm farklılıkları gösteren Word belgesi, şu şekilde kodlanmıştır: Base64 sicim
- dosya adı (dize): Karşılaştırma sonuçlarını içeren çıktı Word dosyasının adı
- başarı (mantıksal değer): İsteğin başarılı olup olmadığını gösterir.
- hataMesajı (dize 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
- Değişikliklerin nasıl izlendiğini incelemek için belgeyi Word'de açın.
- Gerekli değişiklikleri kabul edin veya reddedin.
Ö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 contains tracked changes
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 (
ilkBelgeileİsim,ilkBelgeİçeriği,ikinciBelgeileİsim,ikinciBelgeİçeriği) - İlk belge boş veya geçersiz.
- İkinci belge boş veya geçersiz.
- Geçersiz Base64 belge içeriğinde kodlama
- Geçersiz veya bozuk Word belgeleri
- 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ı
- Belge karşılaştırma hatası
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 tracked changes
"fileName": "string", // Output Word filename with comparison results
"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('comparison.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("comparison.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 Gerekli Alanlar):
{
"firstDocument": { "Name": "original.docx" },
"firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"secondDocument": { "Name": "modified.docx" },
"secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}
Gelişmiş Örnek (Karşılaştırma Seçenekleriyle):
{
"firstDocument": { "Name": "original.docx" },
"firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"secondDocument": { "Name": "modified.docx" },
"secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"comparisonOptions": {
"ignoreFormatting": false,
"ignoreCaseChanges": false,
"ignoreComments": true,
"ignoreTables": false,
"ignoreFields": true,
"ignoreFootnotes": false,
"ignoreTextboxes": false,
"ignoreHeadersAndFooters": false,
"author": "Legal Review System"
}
}
Yalnızca İçerik Karşılaştırma Örneği:
{
"firstDocument": { "Name": "original.docx" },
"firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"secondDocument": { "Name": "modified.docx" },
"secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"comparisonOptions": {
"ignoreFormatting": true,
"ignoreCaseChanges": true,
"ignoreComments": true,
"ignoreFields": true,
"author": "Content Review"
}
}
Kod Örnekleri
O PDF4me Belgeleri Karşılaştır 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
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
- Sözleşme İncelemesiSözleşme sürümlerini karşılaştırarak değişiklikleri ve düzenlemeleri belirleyin.
- Hukuki Belge GüncellemeleriHukuki belgelerde, sözleşmelerde ve mahkeme evraklarında yapılan değişiklikleri takip edin.
- Uyumluluk İzleme: Mevzuata uygunluğu sağlamak için politika belgelerini karşılaştırın.
- Müşteri Belge İncelemesiMüşteriyle doğrudan etkileşim kurulan yasal belgelerdeki değişiklikleri takip edin.
İşletme ve Kurumsal Kullanım Senaryoları
- Teklif YönetimiMüşteri gereksinimlerini takip etmek için teklif sürümlerini karşılaştırın.
- Pazarlama Materyali GüncellemeleriPazarlama materyallerindeki ve kampanyalarındaki değişiklikleri takip edin.
- Fiyatlandırma Belgesi DeğişiklikleriFiyat listelerini ve tarife kartlarını karşılaştırın.
- Müşteri Sunumu GüncellemeleriMüşteri sunum materyallerindeki değişiklikleri takip et
Eğitim ve Araştırma Kullanım Örnekleri
- Tıbbi Protokol GüncellemeleriTıbbi prosedür ve protokol belgelerini karşılaştırın.
- Hasta Bakım KılavuzlarıHasta bakım dokümanlarındaki değişiklikleri takip edin.
- Araştırma DokümantasyonuAraştırma protokollerini ve çalışma belgelerini karşılaştırın.
- Uyumluluk BelgeleriSağlık hizmetleri uyumluluk materyallerindeki değişiklikleri takip edin.
Finans ve Bankacılık Kullanım Örnekleri
- Finansal Rapor GüncellemeleriÇeyreklik ve yıllık mali raporları karşılaştırın.
- Bütçe Belgesinde DeğişikliklerBütçe tekliflerinde ve raporlarında yapılan değişiklikleri takip edin.
- Denetim DokümantasyonuFarklı dönemlere ait denetim raporlarını karşılaştırın.
- Düzenleyici Başvurular: Düzenleyici başvuru belgelerindeki değişiklikleri takip edin