Ana içeriğe geç

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.

İlgili Blog Yazıları
Bu özellik için henüz bir blog yazısı yok — yakında yayınlanacak.
Bu arada, her platforma yönelik eğitimler ve iş akışları için PDF4me bloguna göz atın.
Blogu ziyaret edin

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

ParametreTipTanımÖrnek
belge*ObjectBelge tanımlayıcısı. Şunları içermelidir: İsim (string): Çıktı Word dosya adı .docx uzantısıyla{ "Name": "document.docx" }
belge içeriği*Base64Word 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)

ParametreTipTanımÖrnek
başlık içeriğiStringBasit başlık içeriği (isHtml/isHtmlMode kontrol formatı kullanıldığında footerContent ile birlikte kullanılır)"Company Name"
altbilgi içeriğiStringBasit altbilgi içeriği"Page PAGE of NUMPAGES"
isHtmlBooleanBaşlık/altbilgi içeriğinin olup olmadığı HTMLtrue
isHtmlModeBooleanKullanmak HTML içerik işleme modutrue
allPagesHeaderHtmlStringBaşlık HTML Tüm sayfalar için. Destekler PAGE, NUMPAGES, SECTION, SECTIONPAGES"<div style='text-align: center;'>Company Name</div>"
ilkSayfaBaşlığıHTMLStringBaşlık HTML yalnızca ilk sayfa için"<div style='text-align: center;'>Title Page</div>"
evenPagesHeaderHtmlStringBaşlık HTML çift numaralı sayfalar için"<div style='text-align: right;'>Book Title</div>"
oddPagesHeaderHtmlStringBaşlık HTML tek numaralı sayfalar için"<div style='text-align: left;'>Chapter Title</div>"
allPagesFooterHtmlStringAltbilgi HTML tüm sayfalar için"Page PAGE of NUMPAGES"
ilkSayfaAltbilgisiHTMLStringAltbilgi HTML yalnızca ilk sayfa için"<div style='text-align: center;'>Confidential</div>"
evenPagesFooterHtmlStringAltbilgi HTML çift sayfalar için"<div style='text-align: center;'>Page PAGE</div>"
oddPagesFooterHtmlStringAltbilgi HTML tek sayfalar için"<div style='text-align: center;'>Page PAGE</div>"

İsteğe bağlı parametreler (Yazılı başlık/altbilgi)

ParametreTipTanımÖrnek
tümSayfaBaşlığıObjectTü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 / garipSayfalarAltbilgisiObjectSayfa türüne göre altbilgi içeriği-

İsteğe Bağlı Parametreler (Genel)

ParametreTipTanımÖrnek
kültürAdıStringBelge 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 TipiTanımGerekli Parametreler
Tüm SayfalarTüm sayfalarda aynı başlık/altbilgiallPagesHeaderHtml, allPagesFooterHtml (veya yazılmış) allPagesHeader, allPagesFooter)
İlk Sayfaİlk sayfada farklı başlık/altbilgifirstPageHeaderHtml, 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.

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ı:

  1. Kontrol etmek success; eğer doğruysa, şunu çıkarın document tarladan JSON cevap
  2. Şifreyi çöz Base64 Word belgesinin ikili verilerini almak için kullanılan dize
  3. 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();

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ın Authorization: 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# (CSharp) Örnek

Tamamlamak C# Word belgelerindeki üstbilgi ve altbilgileri güncellemek için uygulama:

Sektör Kullanım Örnekleri ve Uygulamaları

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.

Yardım Alın