Başlık ve Alt Bilgileri Güncelleme - Başlık Yönetimi API
PDF4me Başlıkları ve Altbilgileri Güncelle Word belgelerine kapsamlı bir şekilde üstbilgi ve altbilgi eklemenizi veya değiştirmenizi sağlar. HTML İçerik desteği ve profesyonel stil seçenekleri. Bu API Bu hizmet, Word dosyalarını işler ve ilk sayfa, çift/tek sayfalar ve tüm sayfalar dahil olmak üzere farklı sayfa düzenlerine üstbilgi ve altbilgi ekler; ayrıca profesyonel varsayılan stilin otomatik olarak uygulanmasını sağlar. HTML İçerik işleme ve esnek sayfaya özgü biçimlendirme. API Word belgesi içeriğini şu yolla alır: REST API aramalar, kullanarak Base64 Güvenli iletim için kodlama. Sayfa numarası alanları desteğiyle (PAGE, NUMPAGES, SECTION, SECTIONPAGES), HTML Biçimlendirme ve otomatik profesyonel stillendirme özellikleriyle bu çözüm, belge markalaması, sayfa numaralandırma ve profesyonel belge sunumu 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 Sayfa Türleri: Tüm sayfalar, ilk sayfa, çift/tek sayfalar için destek
- HTML İçerik Desteği: Zengin HTML Profesyonel stil ile içerik
- Otomatik StilDüz metin içeriği için profesyonel varsayılan stillendirme
- Sayfa Numarası Alanları: Desteklemek için PAGE, NUMPAGES, SECTION, SECTIONPAGES
- Esnek YerleşimFarklı sayfa türleri için farklı başlıklar/altbilgiler
- Kültür Desteği: Bölgeye özgü belge işleme
- Biçim KorumaOrijinal belge yapısını korur.
- Profesyonel GörünümProfesyonel stil uygulamasının otomatik olarak yapılması
REST API Uç nokta
O PDF4me REST API standart kullanır HTTP Kaynaklarla etkileşim kurmak için kullanılan yöntemler. Tüm başlık ve altbilgi güncelleme işlemleri tek bir uç nokta üzerinden gerçekleştirilir:
- Yöntem: POST
- Uç nokta:
office/ApiV2Word/UpdateHeadersAndFooters
REST API Parametreler
Başlık ve Altbilgileri Güncelleme parametrelerinin 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. Gelişmiş parametreler, sayfaya özgü başlıklar ve altbilgiler üzerinde ayrıntılı kontrol sağlar.
Gerekli Parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| belge* | Object | Belge tanımlayıcısı. Şunları içermelidir: İsim (string): Çıktı Word dosya adı .docx uzantısıyla | { "Name": "document.docx" } |
| belge içeriği* | Base64 | Word belgesinin içeriği kodlanmıştır. Base64Bu belgeye başlık ve altbilgiler eklenecektir. Geçerli bir Word belgesi (.docx, .doc formatlarında) olmalıdır. | base64EncodedDocumentContent |
İsteğe Bağlı Parametreler (Başlık/Alt Bilgi) HTML)
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| başlık içeriği | String | Basit başlık içeriği (isHtml/isHtmlMode kontrol formatı kullanıldığında footerContent ile birlikte kullanılır) | "Company Name" |
| altbilgi içeriği | String | Basit altbilgi içeriği | "Page PAGE of NUMPAGES" |
| isHtml | Boolean | Başlık/altbilgi içeriğinin olup olmadığı HTML | true |
| isHtmlMode | Boolean | Kullanmak HTML içerik işleme modu | true |
| allPagesHeaderHtml | String | Başlık HTML Tüm sayfalar için. Destekler PAGE, NUMPAGES, SECTION, SECTIONPAGES | "<div style='text-align: center;'>Company Name</div>" |
| ilkSayfaBaşlığıHTML | String | Başlık HTML yalnızca ilk sayfa için | "<div style='text-align: center;'>Title Page</div>" |
| evenPagesHeaderHtml | String | Başlık HTML çift numaralı sayfalar için | "<div style='text-align: right;'>Book Title</div>" |
| oddPagesHeaderHtml | String | Başlık HTML tek numaralı sayfalar için | "<div style='text-align: left;'>Chapter Title</div>" |
| allPagesFooterHtml | String | Altbilgi HTML tüm sayfalar için | "Page PAGE of NUMPAGES" |
| ilkSayfaAltbilgisiHTML | String | Altbilgi HTML yalnızca ilk sayfa için | "<div style='text-align: center;'>Confidential</div>" |
| evenPagesFooterHtml | String | Altbilgi HTML çift sayfalar için | "<div style='text-align: center;'>Page PAGE</div>" |
| oddPagesFooterHtml | String | Altbilgi HTML tek sayfalar için | "<div style='text-align: center;'>Page PAGE</div>" |
İsteğe bağlı parametreler (Yazılı başlık/altbilgi)
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| tümSayfaBaşlığı | Object | Tüm sayfalar için yazılı başlık içeriği (HeaderFooterContentInUpdate) | - |
| ilkSayfaBaşlığı | Object | İlk sayfa için yazılı başlık | - |
| hattaSayfaBaşlığı / garipSayfaBaşlığı | Object | Çift/tek sayfalar için yazılı başlık | - |
| tümSayfalarAltbilgisi / ilkSayfaAltbilgisi / evenPagesFooter / garipSayfalarAltbilgisi | Object | Sayfa türüne göre altbilgi içeriği | - |
İsteğe Bağlı Parametreler (Genel)
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| kültürAdı | String | Belge işleme için kültür kodu (örneğin, "en-US", "fr-FR", "de-DE"). Varsayılan: null. Belge dilini ve biçimlendirmesini etkiler. | en-US |
HTML İçerik Desteği
O API destekler HTML Başlık ve altbilgi parametrelerinin tümündeki içerik:
- HTML EtiketlerStandart HTML Etiketler (div, span, p, b, i, u, vb.)
- CSS StiliBiçimlendirme için satır içi CSS stilleri
- Düz MetinDüz metin otomatik olarak profesyonel varsayılan biçimlendirme alır.
- Karışık İçerik: Birleştir HTML ve gerektiğinde düz metin olarak
Düz Metin için Varsayılan Biçimlendirme:
- Başlıklar: Sol hizalama, alt kenarlık, 10px yazı tipi
- Altbilgiler: Ortaya hizala, üstten kenarlık, 9px yazı tipi
Sayfa Düzeni Seçenekleri
O API Başlık ve altbilgiler için farklı sayfa düzenlerini destekler:
| Yerleşim Tipi | Tanım | Gerekli Parametreler |
|---|---|---|
| Tüm Sayfalar | Tüm sayfalarda aynı başlık/altbilgi | allPagesHeaderHtml, allPagesFooterHtml (veya yazılmış) allPagesHeader, allPagesFooter) |
| İlk Sayfa | İlk sayfada farklı başlık/altbilgi | firstPageHeaderHtml, firstPageFooterHtml (veya yazılı karşılıkları) |
| Çift/Tek Sayfalar | Çift ve tek sayfalar için farklı başlıklar/altbilgiler. | evenPagesHeaderHtml, oddPagesHeaderHtml, evenPagesFooterHtml, oddPagesFooterHtml (veya yazılı karşılıkları) |
Çıktı
O PDF4me Başlıkları ve Altbilgileri Güncelle REST API bir döndürür JSON yanıt. Başarı durumunda API Word belgesini şu şekilde döndürür: Base64-kodlanmış dize içinde document alan (ApiV2WordApiCallRes), ikili veri olarak değil.
- Success Response
- Error Responses
- Response Format Details
Başarılı Yanıt
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üncellenmiş başlık ve altbilgilere sahip Word belgesi, şu şekilde kodlanmıştır: Base64
- dosya adı (string): Çıktı Word dosyasının adı
- başarı (booleanOperasyonun başarılı olup olmadığı
- hataMesajı (string): Başarı başarısız olursa hata mesajı; aksi halde boş değer.
Kullanım Talimatları:
- Kontrol etmek
success; eğer doğruysa, şunu çıkarındocumenttarladan JSON cevap - Şifreyi çöz Base64 Word belgesinin ikili verilerini almak için kullanılan dize
- Word dosyasını şu şekilde kaydedin veya işleyin:
fileName
Örnek (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const base64 = data.document;
const binary = atob(base64);
const blob = new Blob([binary], { type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = data.fileName;
a.click();
Hata Yanıtları
O API standart iadeler HTTP Hata kodları ve hata detayları:
- Geçersiz istek parametreleri
- Gerekli alanlar eksik (
belge,belge içeriği) - Geçersiz Base64 kodlamada
belge içeriği - Geçersiz veya bozuk Word belgesi
- Geçersiz HTML sağlanan içerik
- Geçersiz kültür adı sağlandı.
- Sayfa numarası alanı desteklenmiyor (kullanınız) PAGE, NUMPAGES, SECTION, SECTIONPAGES)
- 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ı
- Başlık ve altbilgileri güncellerken hata oluştu.
- Bytes'tan belge yüklenirken hata oluştu.
- Belgeyi bayta dönüştürürken 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 JSON ile Base64-Dosya içeriği kodlanarak işlenir, asla doğrudan ikili Word verisi kullanılmaz.
Yanıt Yapısı (ApiV2WordApiCallRes):
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word file name
"success": true,
"errorMessage": 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
Yanıtın İşlenmesi:
JavaScript/Node.js:
const response = await fetch(url, options);
const data = await response.json();
const base64 = data.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
response_data = response.json()
word_bytes = base64.b64decode(response_data['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
var response = JsonConvert.DeserializeObject<UpdateHeadersFootersResponse>(jsonResponse);
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, 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 (Tüm Sayfaların Başlığı ve Alt Bilgisi):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"allPagesHeaderHtml": "<div style='text-align: center;'>Company Name</div>",
"allPagesFooterHtml": "Page PAGE of NUMPAGES",
"cultureName": "en-US"
}
Gelişmiş Örnek (İlk Sayfa + Çift/Tek Sayfalar):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"firstPageHeaderHtml": "<div style='text-align: center;'>Title Page</div>",
"firstPageFooterHtml": "<div style='text-align: center;'>Confidential</div>",
"oddPagesHeaderHtml": "<div style='text-align: left;'>Chapter Title</div>",
"evenPagesHeaderHtml": "<div style='text-align: right;'>Book Title</div>",
"oddPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
"evenPagesFooterHtml": "<div style='text-align: center;'>Page PAGE</div>",
"cultureName": "en-US"
}
HTML İçerik Örneği:
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"allPagesHeaderHtml": "<div style='text-align: center; color: #333; font-size: 12px; border-bottom: 1px solid #ccc; padding-bottom: 5px;'>Company Name | Department</div>",
"allPagesFooterHtml": "<div style='text-align: center; color: #666; font-size: 9px; border-top: 1px solid #ccc; padding-top: 5px;'>Page PAGE of NUMPAGES | © 2024 Company Name</div>",
"cultureName": "en-US"
}
Düz Metin Örneği (headerContent/footerContent):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"headerContent": "Company Name",
"footerContent": "Page PAGE of NUMPAGES",
"cultureName": "en-US"
}
Kod Örnekleri
O PDF4me Başlıkları ve Altbilgileri Güncelle 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 belgelerindeki üstbilgi ve altbilgileri güncellemek için 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
- Sözleşme BaşlıklarıGizlilik bildirimleri ve yasal sorumluluk reddi beyanları ekleyin.
- Mahkeme BelgeleriDosya numaralarını ve dosyalama bilgilerini ekleyin.
- Hukuki ÖzetlerAvukat bilgilerini ve dava detaylarını ekleyin.
- Uyumluluk Raporları: Yasal düzenleme bilgilerini ve tarihleri ekleyin.
İşletme ve Kurumsal Kullanım Senaryoları
- Belge Markalamasıİş belgelerine şirket logoları ve başlıklar ekleyin.
- Rapor BaşlıklarıOluşturulan raporlara tutarlı başlıklar ve altbilgiler ekleyin.
- TekliflerŞirket bilgilerini ve sayfa numaralarını ekleyin.
- Kurumsal İletişimBelgeler genelinde tutarlı başlık ve altbilgiler uygulayın.
Eğitim ve Araştırma Kullanım Örnekleri
- Akademik MakalelerKurum bilgilerini ve ders detaylarını ekleyin.
- Araştırma RaporlarıFinansman bilgilerini ve teşekkürleri ekleyin.
- Tıbbi ve Araştırma BelgeleriÇalışma bilgilerini, etik onayını ve protokol ayrıntılarını ekleyin.
- İdari BelgelerBölüm ve iletişim bilgilerini ekleyin.
Finans ve Bankacılık Kullanım Örnekleri
- Finansal RaporlarŞirket bilgilerini ve rapor tarihlerini ekleyin.
- Denetim BelgeleriDenetçi bilgilerini ve rapor rakamlarını ekleyin.
- Düzenleyici BaşvurularMevzuata uyumluluk bilgilerini ekleyin.
- Yatırım BelgeleriRisk uyarılarını ve yasal bildirimleri ekleyin.