İçindekiler Tablosunu Güncelle - TOC Yönetmek API
PDF4me İçindekiler Tablosunu Güncelle Bu özellik, kapsamlı biçimlendirme seçenekleri ve profesyonel stillendirme yetenekleriyle Word belgelerindeki İçindekiler tablosunu güncellemenizi veya oluşturmanızı sağlar. API hizmet Word dosyalarını işler ve oluşturur TOCmevcut olanın otomatik olarak algılanmasıyla TOC Alanlar, özelleştirilebilir başlık seviyeleri, köprü desteği, sekme lideri kontrolü, metin büyük/küçük harf seçenekleri ve kültür yerelleştirmesi. API Word belgesi içeriğini şu yolla alır: REST API aramalar, kullanarak Base64 Güvenli iletim için kodlama. Tam kontrol imkanıyla. TOC Görünüm ve işlevsellik açısından bu çözüm, belge navigasyonu, profesyonel biçimlendirme ve otomasyon için idealdir. TOC üretim iş akışları.
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
- Otomatik TOC TespitMevcut olanları bulur ve günceller. TOC alanlar oluşturur veya yenilerini oluşturur
- Özelleştirilebilir Başlık Seviyeleri: Dahil edilecek başlık seviyelerini kontrol edin (1-6)
- Köprü Bağlantı Desteği: Tıklanabilir bağlantıları etkinleştirin veya devre dışı bırakın TOC
- Sekme Lideri KontrolüMetin ve sayfa numaraları arasındaki noktaları göster veya gizle
- Metin Büyük/Küçük Harf Seçenekleri: Büyük harf kullanın veya orijinal büyük/küçük harf durumunu koruyun.
- Kültür YerelleştirmeFarklı diller ve bölgeler için destek
- Profesyonel BiçimlendirmeProfesyonel uygulamaların otomatik olarak uygulanması TOC stil
- Sayfa Numarası EntegrasyonuSayfa numarasının otomatik olarak hesaplanması ve güncellenmesi
REST API Uç nokta
O PDF4me REST API standart kullanır HTTP Kaynaklarla etkileşim kurma yöntemleri. Tüm içerik tablosu güncelleme işlemleri tek bir uç nokta üzerinden gerçekleştirilir:
- Yöntem: POST
- Uç nokta:
office/ApiV2Word/UpdateTableOfContents
REST API Parametreler
İçindekiler Tablosunu Güncelleme 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. Gelişmiş parametreler, ayrıntılı kontrol sağlar. TOC Biçimlendirme ve görünüm.
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. Base64. TOC Bu belge başlıklarından oluşturulmuştur. Geçerli bir Word belgesi olmalıdır (.docx, .doc formatları). | UEsDBBQABgAIAAAA... |
İsteğe bağlı parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| başlıkSeviyeleri | String | Başlık seviyelerine dahil edilecek TOCAralık biçimi: "1-3" (1, 2 ve 3. başlık düzeylerini içerir). Tek düzey: "1". Çoklu aralıklar: "1-2, 4-6". Varsayılan: "1-3". Word'ün yerleşik başlık stilleriyle eşleşir. Belgeyi mevcut olanlar için tarar. TOC Yeni alanlar oluşturur. TOC belge başlangıcında eğer yoksa | "1-3" |
| Köprüleri kullan | Boolean | İçindekiler tablosuna köprü bağlantıları ekleyin. true = TOC Girişler tıklanabilir bağlantılardır (varsayılan). false = düz metin | true |
| Sekme başlığını gizle | Boolean | Sekme lideri noktalarını gizle. true = Metin ve sayfa numaraları arasında nokta yok (varsayılan), false = Metin ve sayfa numaraları arasındaki noktalar | true |
| Büyük harf kullanın | Boolean | Büyük harf kullanın TOC girişler. true = TOC Girişler büyük harflerle yazılır (varsayılan), false = orijinal kasa | true |
| kültürAdı | String | Belge işleme için kültür kodu (örneğin, "en-US", "de-DE", "fr-FR"). Varsayılan: null. Belge dilini ve biçimlendirmesini etkiler. | en-US |
TOC Üretim Davranışı
- Mevcut TOC TespitBelgenin mevcut olup olmadığını tarar. TOC alanlar (FieldType.FieldTOC) ve onları günceller
- Yeni TOC YaratılışHayırsa: TOC var, yenisini yaratıyor TOC belge başlangıcında
- Başlık Düzeyi EşlemeWord'ün yerleşik başlık stilleriyle (Başlık 1, Başlık 2, vb.) eşleşir.
- Saha GüncellemeleriDoğruluk için alanları birden fazla kez günceller.
- Sayfa Düzeni: UpdateFields() ve UpdatePageLayout() fonksiyonlarını sırayla çağırır.
Çıktı
O PDF4me İçindekiler Tablosunu Güncelle 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üncellenmiş içindekiler tablosuna sahip 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) - Geçersiz Base64 kodlamada
belge içeriği - Geçersiz veya bozuk Word belgesi
- Belgede başlık bulunamadı.
- Geçersiz başlık seviyeleri belirtildi (geçersiz format)
- Geçersiz kültür adı sağlandı.
- 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ı
- İçindekiler tablosu güncelleme hatası
- 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 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.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 (Varsayılan Ayarlar):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}
Gelişmiş Örnek (Tüm Seçeneklerle):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"headingLevels": "1-4",
"useHyperlinks": true,
"hideTabLeader": false,
"useUppercase": false,
"cultureName": "en-US"
}
Akademik Makale Örneği:
{
"document": { "Name": "research-paper.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"headingLevels": "1-3",
"useHyperlinks": true,
"hideTabLeader": true,
"useUppercase": true
}
Kod Örnekleri
O PDF4me İçindekiler Tablosunu 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 içindekiler tablosunu 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 NavigasyonuKarmaşık sözleşmeler için ayrıntılı içindekiler tablosu oluşturun.
- Hukuki ÖzetlerMahkeme belgeleri için gezilebilir bir yapı oluşturun.
- Uyumluluk Kılavuzları: Düzenleyici gereklilikler ve prosedürler dizini
- Dava BelgeleriKanıtları ve hukuki argümanları düzenleyin.
İşletme ve Kurumsal Kullanım Senaryoları
- Politika Kılavuzları: Dahili prosedürler ve politikalar dizini
- Teklif YapısıTeklifler ve ihale çağrıları için gezinmesi kolay bir yapı oluşturun.
- Eğitim Materyalleri: Şirk içi eğitim ve işe alım dokümanlarını düzenleyin
- Proje Dokümantasyonu: Proje planlarını ve teslim edilebilir sonuçları yapılandırmak
Eğitim ve Araştırma Kullanım Örnekleri
- Ders Kitabı DiziniEğitim materyalleri için kapsamlı bir içindekiler tablosu oluşturun.
- Araştırma MakaleleriAkademik belge yapısını standartlaştırmak
- Tıbbi ve Klinik Kılavuzlar: Dizin prosedürleri, protokoller ve çalışma materyalleri
- Tez DokümantasyonuLisansüstü ve doktora çalışmalarının yapısı
Finans ve Bankacılık Kullanım Örnekleri
- Finansal RaporlarKarmaşık raporlar için gezinmesi kolay bir yapı oluşturun.
- Politika Kılavuzları: Bankacılık prosedürleri ve düzenlemeleri endeksi
- Denetim DokümantasyonuUyumluluk ve denetim materyallerini organize etmek
- Yatırım Rehberleri: Finansal eğitim içeriğinin yapılandırılması