Memperbarui Header dan Footer - Manajemen Header API

PDF4me Perbarui Header dan Footer Memungkinkan Anda untuk menambahkan atau memodifikasi header dan footer dalam dokumen Word dengan fitur yang komprehensif. HTML dukungan konten dan opsi penataan gaya profesional. Ini API Layanan ini memproses file Word dan menerapkan header dan footer ke berbagai tata letak halaman, termasuk halaman pertama, halaman genap/ganjil, dan semua halaman dengan penerapan gaya default profesional secara otomatis. HTML pemrosesan konten, dan pemformatan khusus halaman yang fleksibel. Ini API menerima konten dokumen Word melalui REST API panggilan, memanfaatkan Base64 pengkodean untuk transmisi yang aman. Dengan dukungan untuk kolom nomor halaman (PAGE, NUMPAGES, SECTION, SECTIONPAGES), HTML Dengan pemformatan dan penataan gaya profesional otomatis, solusi ini ideal untuk branding dokumen, penomoran halaman, dan alur kerja presentasi dokumen profesional.

Postingan Blog Terkait

Belum ada postingan blog untuk fitur ini — akan segera hadir.

Sementara itu, jelajahi blog PDF4me untuk menemukan tutorial dan alur kerja di berbagai platform.

Kunjungi blog ini →

Memverifikasi Identitas Anda API Meminta

Untuk mengakses PDF4me REST APISetiap permintaan harus menyertakan kredensial otentikasi yang tepat. Otentikasi memastikan komunikasi yang aman dan memvalidasi identitas Anda sebagai pengguna yang berwenang. REST API.

Get your api Key

Fitur Utama

• Berbagai Jenis HalamanDukungan untuk semua halaman, halaman pertama, halaman genap/ganjil
• HTML Dukungan Konten: Kaya HTML konten dengan penataan gaya profesional
• Penataan Rambut OtomatisGaya default profesional untuk konten teks biasa
• Kolom Nomor Halaman: Dukungan untuk PAGE, NUMPAGES, SECTION, SECTIONPAGES
• Tata Letak FleksibelHeader/footer yang berbeda untuk berbagai jenis halaman.
• Dukungan Budaya: Pemrosesan dokumen khusus lokal
• Pelestarian FormatMempertahankan struktur dokumen asli
• Penampilan Profesional: Penerapan gaya profesional secara otomatis

REST API Titik akhir

Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi pembaruan header dan footer dilakukan melalui satu titik akhir:

• Metode: POST
• Titik akhir: office/ApiV2Word/UpdateHeadersAndFooters

REST API Parameter

Daftar lengkap parameter untuk Pembaruan Header dan Footer REST APIParameter-parameter tersebut diorganisir berdasarkan kategori untuk pemahaman dan implementasi yang lebih baik.

Penting: Parameter yang ditandai dengan tanda bintang (*) wajib diisi. Parameter lanjutan memberikan kontrol yang lebih detail atas header dan footer khusus halaman.

Parameter yang Diperlukan

Parameter	Jenis	Keterangan	Contoh
dokumen*	Object	Deskripsi dokumen. Harus mencakup Nama (string): menghasilkan nama file Word dengan ekstensi .docx	{ "Name": "document.docx" }
Konten dokumen*	Base64	Konten dokumen Word yang dikodekan dalam Base64Header dan footer ditambahkan ke dokumen ini. Harus berupa dokumen Word yang valid (.docx, .doc format)	base64EncodedDocumentContent

Parameter Opsional (Header/Footer) HTML)

Parameter	Jenis	Keterangan	Contoh
Konten header	String	Konten header sederhana (digunakan dengan footerContent saat format kontrol isHtml/isHtmlMode)	"Company Name"
Konten footer	String	Konten footer sederhana	"Page PAGE of NUMPAGES"
isHtml	Boolean	Apakah konten header/footer HTML	true
isHtmlMode	Boolean	Menggunakan HTML mode untuk pemrosesan konten	true
semuaHeaderHtml	String	Judul HTML untuk semua halaman. Mendukung PAGE, NUMPAGES, SECTION, SECTIONPAGES	"<div style='text-align: center;'>Company Name</div>"
firstPageHeaderHtml	String	Judul HTML hanya untuk halaman pertama	"<div style='text-align: center;'>Title Page</div>"
evenPagesHeaderHtml	String	Judul HTML untuk halaman bernomor genap	"<div style='text-align: right;'>Book Title</div>"
HeaderHtml HalamanOdd	String	Judul HTML untuk halaman bernomor ganjil	"<div style='text-align: left;'>Chapter Title</div>"
HTML Footer SemuaHalaman	String	Catatan kaki HTML untuk semua halaman	"Page PAGE of NUMPAGES"
firstPageFooterHtml	String	Catatan kaki HTML hanya untuk halaman pertama	"<div style='text-align: center;'>Confidential</div>"
evenPagesFooterHtml	String	Catatan kaki HTML untuk halaman genap	"<div style='text-align: center;'>Page PAGE</div>"
oddPagesFooterHtml	String	Catatan kaki HTML untuk halaman ganjil	"<div style='text-align: center;'>Page PAGE</div>"

Parameter Opsional (Header/footer yang diketik)

Parameter	Jenis	Keterangan	Contoh
Header semua halaman	Object	Konten header yang diketik untuk semua halaman (HeaderFooterContentInUpdate)	-
Header Halaman Pertama	Object	Header yang diketik untuk halaman pertama	-
Header Halaman Genap / Header Halaman Ganjil	Object	Header yang diketik untuk halaman genap/ganjil	-
Footer semua halaman / Catatan kaki halaman pertama / Halaman Genap / Halaman ganjil	Object	Konten footer yang diketik per jenis halaman	-

Parameter Opsional (Umum)

Parameter	Jenis	Keterangan	Contoh
nama budaya	String	Kode budaya untuk pemrosesan dokumen (misalnya, "en-US", "fr-FR", "de-DE"). Nilai default: null. Mempengaruhi bahasa dan format dokumen.	en-US

HTML Dukungan Konten

Yang API mendukung HTML Konten di semua parameter header dan footer:

• HTML TagStandar : HTML tag (div, span, p, b, i, u, dll.)
• Gaya CSSGaya CSS inline untuk pemformatan
• Teks BiasaTeks biasa secara otomatis menerima gaya default profesional.
• Konten Campuran: Gabungkan HTML dan teks biasa sesuai kebutuhan.

Gaya Default untuk Teks Biasa:

• Judul: Perataan kiri, batas bawah, ukuran font 10px
• Catatan kaki: Perataan tengah, border atas, font 9px

Opsi Tata Letak Halaman

Yang API Mendukung berbagai tata letak halaman untuk header dan footer:

Jenis Tata Letak	Keterangan	Parameter yang Diperlukan
Semua Halaman	Header/footer yang sama di semua halaman.	allPagesHeaderHtml, allPagesFooterHtml (atau diketik) allPagesHeader, allPagesFooter)
Halaman Pertama	Header/footer berbeda di halaman pertama	firstPageHeaderHtml, firstPageFooterHtml (atau padanan yang diketik)
Halaman Genap/Ganjil	Header/footer yang berbeda untuk halaman genap dan ganjil.	evenPagesHeaderHtml, oddPagesHeaderHtml, evenPagesFooterHtml, oddPagesFooterHtml (atau padanan yang diketik)

Keluaran

Yang PDF4me Perbarui Header dan Footer REST API mengembalikan JSON tanggapan. Jika berhasil, maka API mengembalikan dokumen Word sebagai Base64-string yang dikodekan di dalam document bidang (ApiV2WordApiCallRes), bukan sebagai data biner.

Success Response

Respons Sukses

Kode Status: 200 OK

Tipe Konten: application/json

Isi Tanggapan:

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

Kolom Respons:

• dokumen (string): Dokumen Word dengan header dan footer yang diperbarui, dikodekan sebagai Base64
• nama file (string): Nama file Word keluaran
• kesuksesan (boolean): Apakah operasi tersebut berhasil
• pesan kesalahan (string): Pesan kesalahan jika keberhasilan bernilai salah; jika tidak, bernilai null.

Cara Penggunaan:

1. Memeriksa success; jika benar, ekstrak document lapangan dari JSON tanggapan
2. Uraikan kodenya Base64 string untuk mendapatkan data biner dokumen Word
3. Simpan atau proses file Word menggunakan fileName

Contoh (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();

Error Responses

Respons Kesalahan

Yang API pengembalian standar HTTP Kode kesalahan beserta detail kesalahannya:

400 Bad Request

• Parameter permintaan tidak valid
• Kolom yang wajib diisi belum terisi (dokumen, Konten dokumen)
• Tidak sah Base64 pengkodean dalam Konten dokumen
• Dokumen Word tidak valid atau rusak
• Tidak sah HTML konten yang disediakan
• Nama budaya yang diberikan tidak valid.
• Kolom nomor halaman tidak didukung (gunakan PAGE, NUMPAGES, SECTION, SECTIONPAGES)

401 Unauthorized

• Tidak valid atau hilang API kunci
• API kunci tidak berfungsi dengan benar Base64 dikodekan dalam Authorization judul
• Hilang Otorisasi: Dasar judul

500 Internal Server Error

• Kesalahan pemrosesan sisi server
• Kegagalan pemrosesan dokumen Word
• Terjadi kesalahan saat memperbarui header dan footer.
• Terjadi kesalahan saat memuat dokumen dari byte.
• Terjadi kesalahan saat mengkonversi dokumen ke byte.

Format Respons Kesalahan:

{
"error": "Error message describing what went wrong"
}

Response Format Details

Detail Format Respons

Penting: Yang API selalu kembali JSON dengan Base64-konten dokumen Word yang dikodekan, bukan data biner Word secara langsung.

Struktur Respons (ApiV2WordApiCallRes):

{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word file name
"success": true,
"errorMessage": null
}

Header Content-Type:

• Kesuksesan: application/json
• Dokumen Word disematkan sebagai Base64 tali di dalam JSON tanggapan

Mengapa Base64?

• JSON- Pengkodean aman untuk data biner
• Mudah ditransmisikan melalui HTTP
• Kompatibel dengan semua bahasa pemrograman
• Dapat langsung disematkan di JSON tanpa menghindari masalah

Memproses Respons:

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);

Contoh Permintaan

Judul

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Catatan:

• Dapatkan milikmu API kunci dari PDF4me Dasbor
• Yang API kunci harus Base64 dikodekan dan diawali dengan "Basic" di dalam Authorization judul
• Contoh: Jika Anda API kuncinya adalah abc123, mengkodekannya menjadi Base64 dan menggunakan Authorization: Basic YWJjMTIz

Muatan

Contoh Dasar (Header dan Footer Semua Halaman):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "allPagesHeaderHtml": "<div style='text-align: center;'>Company Name</div>",
 "allPagesFooterHtml": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

Contoh Lanjutan (Halaman Pertama + Halaman Genap/Ganjil):

{
 "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"
}

Contoh Konten HTML:

{
 "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"
}

Contoh Teks Biasa (headerContent/footerContent):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "headerContent": "Company Name",
 "footerContent": "Page PAGE of NUMPAGES",
 "cultureName": "en-US"
}

Contoh Kode

Yang PDF4me Perbarui Header dan Footer REST API Menyediakan contoh kode dalam berbagai bahasa pemrograman. Pilih bahasa yang paling sesuai dengan lingkungan pengembangan Anda:

C#

C# (CSharp) Contoh

Menyelesaikan C# Implementasi untuk memperbarui header dan footer pada dokumen Word:

View C# Sample

Java

Java Contoh

Java Implementasi dengan penanganan kesalahan dan pemrosesan respons yang lengkap:

View Java Sample

JavaScript

JavaScript Contoh

Node.js dan kompatibel dengan browser JavaScript implementasi:

View JavaScript Sample

Python

Python Contoh

Python implementasi dengan pustaka permintaan dan JSON penanganan:

View Python Sample

Salesforce

Salesforce Contoh

Salesforce Apex implementasi untuk CRM integrasi:

View Salesforce Sample

n8n

n8n Contoh

n8n Implementasi alur kerja untuk otomatisasi:

View n8n Sample

Google Script

Google Script Contoh

Google Apps Script implementasi untuk Google Workspace integrasi:

View Google Script Sample

AWS Lambda

AWS Lambda Contoh

Tanpa server AWS Lambda implementasi fungsi:

View AWS Lambda Sample

Studi Kasus & Aplikasi Industri

Legal & Professional Services

Studi Kasus Layanan Hukum & Profesional

• Header KontrakTambahkan pemberitahuan kerahasiaan dan penafian hukum.
• Dokumen PengadilanSertakan nomor kasus dan informasi pengajuan.
• Ringkasan HukumTambahkan informasi pengacara dan detail kasus.
• Laporan KepatuhanSertakan informasi dan tanggal peraturan.

Business & Enterprise

Kasus Penggunaan Bisnis & Perusahaan

• Branding DokumenTambahkan logo dan header perusahaan ke dokumen bisnis.
• Header LaporanTambahkan header dan footer yang konsisten pada laporan yang dihasilkan.
• UsulanSertakan informasi perusahaan dan penomoran halaman.
• Komunikasi KorporatTerapkan header dan footer yang konsisten di seluruh dokumen.

Education & Research

Studi Kasus Pendidikan & Penelitian

• Makalah AkademikTambahkan informasi institusi dan detail kursus.
• Laporan PenelitianSertakan informasi pendanaan dan ucapan terima kasih.
• Dokumen Medis dan PenelitianTambahkan informasi studi, persetujuan etik, dan detail protokol.
• Dokumen AdministratifSertakan informasi departemen dan kontak.

Finance & Banking

Studi Kasus Keuangan & Perbankan

• Laporan KeuanganTambahkan informasi perusahaan dan tanggal laporan.
• Dokumen AuditSertakan informasi auditor dan nomor laporan.
• Pengajuan PeraturanTambahkan informasi kepatuhan peraturan.
• Dokumen InvestasiSertakan pernyataan penafian risiko dan pemberitahuan hukum.

Dapatkan Bantuan

Get Your API KeyAPI SamplesGetting Started