Menambahkan HTML Header Footer ke PDF - Pencitraan Merek API
PDF4me Menambahkan HTML Header Footer ke PDF memungkinkan Anda untuk menambahkan HTML konten sebagai header, footer, atau keduanya untuk PDF dokumen. Ini API proses layanan PDF berkas dan menambahkan HTML Konten dengan penempatan yang tepat, margin khusus, dan opsi penargetan halaman untuk branding dan pengorganisasian dokumen. API menerima PDF konten dan HTML data melalui REST API panggilan, memanfaatkan Base64 pengkodean untuk keamanan PDF transmisi. Dengan dukungan untuk HTML Dengan konten yang lengkap, pen positioning yang fleksibel, margin kustom, penargetan halaman, dan pengecualian halaman pertama, solusi ini ideal untuk branding dokumen, pembuatan laporan, dan aplikasi perusahaan. PDF alur kerja.
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.
Fitur Utama
- HTML Dukungan KontenTambahkan kaya HTML konten sebagai header dan footer dengan dukungan styling penuh.
- Penempatan FleksibelKontrol penempatan header dan footer dengan kontrol margin yang tepat.
- Penataan Gaya Kustom: Penuh HTML Dan CSS dukungan untuk penampilan profesional
- Penargetan Halaman: Terapkan header dan footer ke halaman tertentu atau seluruh dokumen
- Lewati Halaman PertamaOpsi untuk mengecualikan header dan footer dari halaman pertama.
- Hasil ProfesionalBuat header dan footer yang meningkatkan pengorganisasian dan branding dokumen.
- Tanpa sambungan API Integrasi: REST API dirancang untuk otomatis PDF pengeditan alur kerja dan integrasi sistem perusahaan
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi penambahan header dan footer dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
/api/v2/AddHtmlHeaderFooter
Fitur Header dan Footer
HTML Dukungan Konten
- HTML Isi: Dukungan untuk HTML konten dengan inline CSS penataan gaya
- Penataan Gaya Kustom: Gunakan inline CSS untuk font, warna, perataan, dan gaya dasar.
- Teks dan Gambar: Dukungan untuk HTML konten teks dan gambar yang disematkan
- Polos HTML Rangkaian: HTML Konten harus diberikan sebagai string biasa (bukan Base64 dikodekan)
Penempatan dan Tata Letak
- Kontrol MarginPenentuan posisi yang tepat dengan pengukuran berbasis piksel (marginLeft, marginRight, marginTop, marginBottom)
- Penargetan Halaman: Terapkan ke halaman tertentu menggunakan opsi halaman (string kosong untuk semua halaman, "1", "1,3,5", "2-5", "1,3,7-10", "2-")
- Lewati Halaman PertamaOpsi untuk mengecualikan header dan footer dari halaman pertama.
- Opsi LokasiTambahkan konten sebagai Header, Footer, atau Keduanya
Fitur Lanjutan
- Pemrosesan AsinkronDukungan untuk pemrosesan asinkron dengan polling untuk operasi yang berjalan lama.
- Penampilan Profesional: Format dan gaya yang konsisten di seluruh dokumen
- Penempatan FleksibelKontrol penempatan header dan footer dengan pengukuran piksel yang tepat.
REST API Parameter
Daftar lengkap parameter untuk Penambahan HTML Header Footer ke PDF REST APIParameter-parameter tersebut diorganisir berdasarkan kategori untuk pemahaman dan implementasi yang lebih baik.
Penting: Parameter yang ditandai dengan tanda bintang (*) wajib diisi dan harus diberikan agar dapat digunakan. API agar berfungsi dengan benar.
Parameter yang Diperlukan
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| Nama dokumen* | String | Keluaran PDF nama file dengan ekstensi .pdf | output.pdf |
| Konten dokumen* | Base64 | Isi dari input PDF berkas yang dikodekan dalam Base64 | JVBERi... |
| htmlContent* | String | HTML isi (polos) HTML string, BUKAN yang dikodekan base64) untuk ditambahkan sebagai header atau footer | <div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div> |
| lokasi* | String | Lokasi untuk HTML isi: Judul, Catatan kaki, atau Keduanya | Header |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| halaman | String | Opsi halaman: string kosong untuk semua halaman, "1" untuk halaman 1, "1,3,5" untuk halaman tertentu, "2-5" untuk rentang halaman, "1,3,7-10" untuk campuran, "2-" untuk halaman 2 sampai akhir | "" atau "1-3" |
| Lewati halaman pertama | Boolean | Lewati halaman pertama (benar) atau sertakan halaman pertama (salah) | false |
| marginKiri | Dobel | Margin kiri dalam piksel | 20.0 |
| marginKanan | Dobel | Margin kanan dalam piksel | 20.0 |
| marginAtas | Dobel | Margin atas dalam piksel | 50.0 |
| marginBottom | Dobel | Margin bawah dalam piksel | 50.0 |
| asinkron | Boolean | Aktifkan pemrosesan asinkron. Saat true, itu API mengembalikan status 202 dan menyediakan polling URL di dalam Location judul | true |
Catatan Penting: Yang
htmlContentparameter harus berupa polos HTML rangkaian, bukan Base64 dikodekan. Anda dapat menyertakan secara inline. CSS penataan gaya di dalam HTML.
Keluaran
Yang PDF4me Menambahkan HTML Header Footer ke PDF REST API Mengembalikan respons yang berbeda berdasarkan mode pemrosesan. API mengembalikan PDF sebagai Base64-string yang dikodekan dalam JSON format, bukan sebagai data biner.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Pemrosesan Sinkron (Default)
Kapan async tidak diatur atau diatur ke false, itu API memproses permintaan tersebut dengan segera:
Kode Status: 200 OK
Content-Type: application/json
Isi Tanggapan:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Kolom Respons:
- Nama dokumen (string): Output PDF nama file
- Konten dokumen (string): The PDF berkas dengan HTML Header/footer diterapkan, dikodekan sebagai Base64 rangkaian
Cara Penggunaan:
- Ekstrak
docContentlapangan dari JSON tanggapan - Uraikan kodenya Base64 string untuk mendapatkan biner PDF data
- Simpan atau proses PDF berkas sesuai kebutuhan
Contoh (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
Pemrosesan Asinkron
Kapan async: true sudah ditetapkan, API memproses permintaan secara asinkron:
Kode Status: 202 Accepted
Header Respons:
Location: https://api.pdf4me.com/api/v2/AddHtmlHeaderFooter/poll/12345-abcde-67890
Proses Pemungutan Suara:
- Ekstrak
Locationheader dari respons 202 - Jajak pendapat URL menggunakan GET permintaan
- Lanjutkan jajak pendapat hingga Anda menerima 200 OK status
- Jawaban terakhir berisi hal yang sama. JSON format dengan
docNameDandocContent(Base64)
Contoh Polling:
// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');
// Poll until complete
while (true) {
const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
if (pollResponse.status === 200) {
const data = await pollResponse.json();
// Process data.docContent (Base64 PDF)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
Respons Kesalahan
Yang API pengembalian standar HTTP Kode kesalahan beserta detail kesalahannya:
- Parameter permintaan tidak valid
- Kolom yang wajib diisi belum terisi (
Nama dokumen,Konten dokumen,htmlContent,lokasi) - Tidak sah Base64 pengkodean dalam
Konten dokumen - Nilai lokasi tidak valid (harus berupa: Header, Footer, atau Keduanya)
- Tidak sah HTML isi
- Tidak valid atau hilang API kunci
- API kunci tidak berfungsi dengan benar Base64 dikodekan dalam Authorization judul
- Hilang
Otorisasi: Dasarjudul
- Kesalahan pemrosesan sisi server
- PDF kegagalan pemrosesan
- HTML kegagalan rendering
Format Respons Kesalahan:
{
"error": "Error message describing what went wrong"
}
Detail Format Respons
Penting: Yang API selalu kembali JSON, tidak pernah biner PDF data secara langsung.
Struktur Respons:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type Judul:
- Kesuksesan:
application/json - Yang PDF tertanam 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
Mendekode Base64 ke PDF:
JavaScript/Node.js:
const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js
Python:
import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
f.write(pdf_bytes)
C#:
byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", pdfBytes);
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 menggunakanAuthorization: Basic YWJjMTIz
Muatan
Contoh Sederhana (Hanya Kolom yang Wajib Diisi):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
"location": "Header"
}
Contoh Lanjutan (Dengan Semua Kolom Opsional):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
"location": "Header",
"pages": "",
"skipFirstPage": false,
"marginLeft": 20.0,
"marginRight": 20.0,
"marginTop": 50.0,
"marginBottom": 50.0,
"async": true
}
Penting: Yang
htmlContentkolom harus berisi polos HTML sebagai sebuah string, bukan Base64 dikodekan. Anda dapat menggunakan inline. CSS penataan gaya di dalam HTML tag.
Contoh Kode
Yang PDF4me Menambahkan HTML Header Footer ke PDF REST API Menyediakan contoh kode dalam berbagai bahasa pemrograman. Pilih bahasa yang paling sesuai dengan lingkungan pengembangan Anda:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Contoh
Menyelesaikan C# implementasi untuk menambahkan header dan footer ke PDF:
Java Contoh
Java Implementasi dengan penanganan kesalahan dan pemrosesan respons yang lengkap:
JavaScript Contoh
Node.js dan kompatibel dengan browser JavaScript implementasi:
Google Script Contoh
Google Apps Script implementasi untuk Google Workspace integrasi:
Studi Kasus & Aplikasi Industri
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Studi Kasus Layanan Hukum & Profesional
- Dokumentasi Hukum: Terapkan pernyataan penafian hukum dan pemberitahuan kerahasiaan pada dokumen hukum
- Header KontrakTambahkan header dan footer pada kontrak dan perjanjian.
- Dokumentasi KepatuhanSertakan pemberitahuan kepatuhan di bagian header dan footer.
- Dokumentasi KlienTambahkan header dan footer profesional ke dokumen klien.
Kasus Penggunaan Bisnis & Perusahaan
- Branding DokumenTambahkan logo perusahaan, header, dan footer ke dokumen PDF.
- Pembuatan LaporanTambahkan header dan footer yang konsisten pada laporan yang dihasilkan.
- Dokumen BisnisTingkatkan tampilan profesional dengan header dan footer bermerek.
- Pencitraan Merek PerusahaanTerapkan header dan footer yang konsisten di seluruh dokumen bisnis.
Studi Kasus Pendidikan & Penelitian
- Makalah Akademik: Menambahkan nomor halaman, header, dan footer pada publikasi akademik
- Dokumen Penelitian: Format makalah penelitian dengan header dan footer yang tepat
- Pemformatan TesisTambahkan header dan footer pada tesis dan disertasi.
- Materi Pendidikan: Tingkatkan dokumen pendidikan dengan header dan footer
Studi Kasus Keuangan & Perbankan
- Laporan KeuanganTambahkan header dan footer pada laporan dan pernyataan keuangan.
- Pemformatan Faktur: Menambahkan header dan footer pada faktur dan dokumen keuangan
- Dokumentasi KepatuhanSertakan informasi kepatuhan di bagian header dan footer.
- Laporan AuditTambahkan header dan footer profesional ke laporan audit.