Metni Değiştir - Metin Değiştirme API
PDF4me Metni Değiştir Bu özellik, gelişmiş arama seçenekleriyle Word belgelerindeki metinleri bulmanıza ve değiştirmenize olanak tanır. API Bu servis, Word dosyalarını işler ve büyük/küçük harf duyarlılığına duyarlı eşleştirme ve tam kelime eşleştirme yöntemleriyle birden fazla değiştirme işlemi gerçekleştirir. API Word belgesi içeriğini şu yolla alır: REST API aramalar, kullanarak Base64 Güvenli iletim için kodlama. Tek bir istekte birden fazla bul ve değiştir işlemini destekleyen bu çözüm, belge otomasyonu, şablon işleme ve içerik yönetimi 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
- Çoklu Metin Değiştirmeleri: Tek bir işlemde birden fazla bul ve değiştir işlemi gerçekleştirin
- Gelişmiş Arama SeçenekleriBüyük/küçük harf duyarlı eşleştirme ve tam kelime eşleştirme
- Sıralı İşleme: Belirtilen sırayla işlenen birden fazla değiştirme işlemi
- Esnek Eşleştirme: Tam eşleşmeler, kısmi eşleşmeler veya tam kelime eşleşmeleri
- Basit YapıKullanımı kolay arama ve değiştirme işlemleri dizisi
REST API Uç nokta
O PDF4me REST API standart kullanır HTTP Kaynaklarla etkileşim kurma yöntemleri. Tüm metin değiştirme işlemleri tek bir uç nokta üzerinden gerçekleştirilir:
- Yöntem: POST
- Uç nokta:
office/ApiV2Word/ReplaceText
REST API Parametreler
Metin Değiştirme işlevi için tüm 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. cümleler Dizide en az bir değiştirme ifadesi bulunmalıdır.
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 belgede metin değiştirme işlemi gerçekleştiriliyor. | UEsDBBQABgAIAAAA... |
| cümleler* | Array | Değiştirme nesneleri dizisi. En az bir değiştirme nesnesi içermelidir. Her değiştirme nesnesi, belirtilen sırayla ardışık olarak işlenir. | Aşağıdaki örneğe bakın. |
Metin Değiştirme Nesnesi Yapısı (ifadeler dizisi)
Her bir öğe cümleler Dizi, aşağıdaki yapıya sahip bir nesne olmalıdır:
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| findText* | String | Belgede aranacak metin dizesi. Boş veya null olamaz. Büyük/küçük harf duyarlılığı, matchCase ayarına bağlıdır. Bu metnin tüm örnekleri değiştirilecektir. | "old text" |
| replaceText | String | Bulunan metnin yerine yazılacak metin. Bulunan metni kaldırmak için boş dize de girilebilir. Varsayılan: boş dize (bulunan metni kaldırır) | "new text" |
| Büyük/küçük harf eşleşmesi | Boolean | Büyük/küçük harf duyarlı eşleştirme. true = Arama büyük/küçük harf duyarlıdır (tam büyük/küçük harf eşleşmesi gereklidir), false = Arama büyük/küçük harf duyarlılığına sahip değildir (varsayılan). "The" ifadesinin "the" ile mi yoksa yalnızca "The" ile mi eşleşeceğini kontrol eder. | false |
| Tam Kelimeyi Eşleştir | Boolean | Kelime kelime eşleştirme. true = Yalnızca tam kelimeleri eşleştirin (kısmi eşleşmeleri değil), false = Kelimeler içindeki kısmi metni eşleştir (varsayılan). "The" kelimesinin "there" veya "other" ile eşleşmesini engeller. | false |
İsteğe bağlı parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| kültürAdı | String | Belge işlemeye yönelik kültür kodu (ör. "en-US", "de-DE", "fr-FR") | en-US |
Metin Değiştirme İşlemi
- Her bir değiştirme işlemi, belirtilen sıraya göre ardışık olarak işlenir.
- Aynı belge üzerinde birden fazla değiştirme işlemi gerçekleştirilebilir.
- "Metin Bul" işlevinin tüm örnekleri değiştirilir (tam kelime eşleştirme kullanılmadığı sürece).
Çıktı
O PDF4me Metni Değiştir 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): Metin değişiklikleri 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.
Örnek (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes
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,cümleler) - İfadeler dizisi boş veya geçersiz.
- Değiştirme işleminde "metin boş veya geçersiz" ifadesini bul.
- Geçersiz Base64 kodlamada
belge içeriği - Geçersiz veya bozuk Word belgesi
- Geçersiz yazı tipi boyutu veya biçimlendirme parametreleri
- 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ı
- Metin değiştirme 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 content
"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.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['docContent'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.docContent);
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 (Tekli Değiştirme):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"phrases": [
{
"findText": "old text",
"replaceText": "new text",
"matchCase": false,
"matchWholeWord": false
}
],
"cultureName": "en-US"
}
Gelişmiş Örnek (Birden Fazla Değiştirme):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"phrases": [
{
"findText": "[COMPANY_NAME]",
"replaceText": "Acme Corporation",
"matchCase": false,
"matchWholeWord": false
},
{
"findText": "[DATE]",
"replaceText": "2024-01-15",
"matchCase": false,
"matchWholeWord": false
},
{
"findText": "[CONTACT_EMAIL]",
"matchCase": false,
"matchWholeWord": false
}
],
"cultureName": "en-US"
}
Kod Örnekleri
O PDF4me Metni Değiştir 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 İşlemeYer tutucu metni müşteriye özel bilgilerle değiştirin.
- Hukuk Belgelerinin OtomasyonuVaka numaralarını, müşteri adlarını ve tarihleri güncelleyin.
- Şablon StandardizasyonuHukuki terminolojiyi ve biçimlendirmeyi standartlaştırmak
- Müşteri İletişimi: Belirli müşteriler için yasal belgeleri kişiselleştirin
İşletme ve Kurumsal Kullanım Senaryoları
- Teklif OluşturmaTeklif şablonlarını müşteriye özel bilgilerle değiştirin.
- Pazarlama Materyali OluşturmaKampanya ayrıntılarıyla pazarlama şablonlarını güncelleyin.
- Müşteri İletişimi: Belirli potansiyel müşteriler için satış belgelerini kişiselleştirin
- Rapor StandardizasyonuSatış terminolojisini ve biçimlendirmesini standartlaştırın.
Eğitim ve Araştırma Kullanım Örnekleri
- Tıbbi Rapor OluşturmaTıbbi şablonları hastaya özel bilgilerle değiştirin.
- Hasta İletişimi: Belirli hastalar için tıbbi belgeleri kişiselleştirin
- Araştırma DokümantasyonuAraştırma şablonlarını çalışmaya özgü verilerle güncelleyin.
- Uyumluluk BelgeleriTıbbi uyumluluk şablonlarını güncel standartlara göre güncelleyin.
Finans ve Bankacılık Kullanım Örnekleri
- Finansal Rapor OluşturmaŞablon verilerini gerçek finansal ölçütlerle değiştirin.
- Fatura İşlemeFatura şablonlarını müşteri ve ödeme bilgileriyle güncelleyin.
- Bütçe Belgesi OtomasyonuBütçe yer tutucularını gerçek rakamlarla değiştirin.
- Denetim Raporu OluşturmaDenetim şablonlarını belirli denetim bulgularıyla güncelleyin.