Tambahkan Gambar Header Footer - Excel API
PDF4me Tambahkan Gambar Header Footer memungkinkan Anda menambahkan header dan footer gambar yang dapat disesuaikan ke Excel dokumen dengan kontrol penempatan dan pemformatan yang komprehensif. Ini API proses layanan Excel Mengolah file dan menambahkan header atau footer gambar dengan kontrol penempatan (header/footer), perataan horizontal (kiri, tengah, kanan), penargetan lembar kerja (lembar kerja tertentu atau semua lembar kerja), dan margin halaman dalam sentimeter. API menerima Excel konten dokumen dan data gambar melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan dukungan untuk PNG, JPG, JPEGDengan format gambar GIF dan format lainnya, solusi ini ideal untuk branding perusahaan, laporan profesional, dan alur kerja otomatisasi dokumen.
Memverifikasi Identitas Anda API Meminta
Sertakan milik Anda API masukkan kunci dalam permintaan untuk melakukan otentikasi dengan PDF4me REST API.
Fitur Utama
- Penempatan Header atau FooterPilih apakah gambar akan ditempatkan di bagian header atau footer dokumen.
- Kontrol PosisiAtur posisi gambar ke kiri, tengah, atau kanan di dalam area header/footer.
- Lembar Kerja Penargetan: Terapkan gambar ke lembar kerja tertentu berdasarkan nama atau indeks, atau ke semua lembar kerja
- Kustomisasi MarginAtur margin halaman atas, bawah, kiri, dan kanan dalam sentimeter.
- Dukungan Format Gambar: PNG, JPG, JPEG, dan format GIF
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi header/footer gambar untuk Excel dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
office/ApiV2Excel/ExcelAddImageHeaderFooter
REST API Parameter
Penting: Parameter yang ditandai dengan tanda bintang (*) wajib diisi. Semua permintaan menggunakan dokumen, Konten dokumen, Konten gambar (tingkat akar), dan tambahkanHeaderFooterGambarKeExcelActionOpsi lainnya adalah properti dari objek aksi.
Parameter yang Diperlukan (tingkat akar)
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| dokumen* | Object | Referensi dokumen. Harus memuat Nama (rangkaian): Excel nama file dengan ekstensi .xlsx atau .xls | { "Name": "data.xlsx" } |
| Konten dokumen* | String (Base64) | Excel isi dokumen yang dikodekan dalam Base64 | UEsDBBQABgAIAAAA... |
| Konten gambar* | String (Base64) | Konten berkas gambar dikodekan dalam Base64Mendukung PNG, JPG, JPEG, format GIF | iVBORw0KGgoAAAANS... |
| tambahkanHeaderFooterGambarKeExcelAction* | Object | Konfigurasi tindakan (posisi, penargetan lembar kerja, margin, dll.) | Lihat contoh Payload di bawah ini. |
Parameter Opsional (di dalam addImageHeaderFooterToExcelAction)
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| adalahHeader | Boolean | Seleksi penempatan. true = Tambahkan gambar ke header dokumen (default), false = Tambahkan gambar ke footer dokumen | true |
| posisi | String | Penyelarasan horizontal di dalam header/footer. Kiri, Tengah, atau Benar. Default: "Tengah". Tidak peka terhadap huruf besar/kecil. | Center |
| nama lembar kerja | Array (rangkaian[]) | Array nama lembar kerja yang akan diterapkan gambar. Jika worksheetNames dan worksheetIndexes keduanya kosong, maka akan diterapkan ke semua lembar kerja. | ["Sheet1", "Report"] |
| Indeks lembar kerja | Array (int[]) | Array indeks lembar kerja (berbasis 1). Jika worksheetNames dan worksheetIndexes keduanya kosong, berlaku untuk semua lembar kerja. | [1, 2] |
| margin atas | Angka (ganda) | Margin atas halaman dalam sentimeter. Default: 1,9 | 1.9 |
| margin bawah | Angka (ganda) | Margin bawah halaman dalam sentimeter. Default: 1,9 | 1.9 |
| Margin kiri | Angka (ganda) | Margin halaman kiri dalam sentimeter. Standar: 1,9 | 1.9 |
| margin kanan | Angka (ganda) | Margin halaman kanan dalam sentimeter. Default: 1,9 | 1.9 |
| nama budaya | String | Kode budaya untuk pemrosesan dokumen (misalnya, "en-US", "de-DE", "fr-FR") | en-US |
Catatan: Jika keduanya nama lembar kerja Dan Indeks lembar kerja Jika kosong atau null, gambar akan diterapkan ke semua lembar kerja di Excel berkas.
Keluaran
Yang PDF4me Tambahkan Gambar Header Footer REST API mengembalikan Excel dokumen sebagai Base64-string yang dikodekan dalam JSON format, bukan sebagai data biner.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Pemrosesan Sinkron (Default)
Yang API Memproses permintaan dan mengembalikan:
Kode Status: 200 OK
Content-Type: application/json
Isi Tanggapan:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "data.xlsx",
"success": true,
"errorMessage": null
}
Kolom Respons:
- dokumen (string): The Excel dokumen dengan header/footer gambar yang diterapkan, dikodekan sebagai Base64 rangkaian
- nama file (string): Output Excel nama file
- kesuksesan (boolean): Menunjukkan apakah permintaan berhasil
- pesan kesalahan (string atau null): Detail kesalahan jika keberhasilan bernilai false
Cara Penggunaan:
- Ekstrak
documentlapangan dari JSON tanggapan (Base64) - Uraikan kodenya Base64 string untuk mendapatkan biner Excel data dokumen
- Simpan atau proses Excel berkas sesuai kebutuhan
Contoh (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const excelBytes = atob(data.document); // Decode Base64
// Save or process excelBytes
Pemrosesan Asinkron
Perilaku asinkron (202 Accepted (dengan polling) dikendalikan oleh konfigurasi server, bukan oleh parameter body permintaan. Saat diaktifkan, API dapat mengembalikan status 202 dengan polling URL di dalam Location Judul. Jajak pendapat URL dengan GET permintaan hingga Anda menerima 200 OK dengan bentuk respons yang sama (dokumen, nama file, sukses, pesan kesalahan).
Respons Kesalahan
Yang API pengembalian standar HTTP Kode kesalahan beserta detail kesalahannya:
- Parameter permintaan tidak valid
- Kolom yang wajib diisi belum terisi (
dokumendenganNama,Konten dokumen,Konten gambar,tambahkanHeaderFooterGambarKeExcelAction) - Tidak sah Base64 pengkodean dalam
Konten dokumenatauKonten gambar - Tidak valid atau rusak Excel dokumen
- Berkas gambar tidak valid atau rusak
- Pemilihan lembar kerja tidak valid (nama atau indeks tidak ada atau berada di luar rentang)
- Tidak valid atau hilang API kunci
- API kunci tidak berfungsi dengan benar Base64 dikodekan dalam Authorization judul
- Hilang
Otorisasi: Dasarjudul
- Kesalahan pemrosesan sisi server
- Excel kegagalan pemrosesan dokumen
- Kegagalan penambahan header/footer gambar
Format Respons Kesalahan:
{
"error": "Error message describing what went wrong"
}
Detail Format Respons
Penting: Yang API selalu kembali JSON, tidak pernah biner Excel data secara langsung.
Struktur Respons:
{
"document": "string", // Base64-encoded Excel document content
"fileName": "string", // Output Excel filename
"success": true,
"errorMessage": "string or null"
}
Mendekode Base64 ke Excel Dokumen:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
excel_bytes = base64.b64decode(response['document'])
with open('output.xlsx', 'wb') as f:
f.write(excel_bytes)
C#:
byte[] excelBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.xlsx", excelBytes);
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):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {}
}
Contoh Lanjutan (Dengan Semua Kolom Opsional):
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"imageContent": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"addImageHeaderFooterToExcelAction": {
"isHeader": true,
"position": "Center",
"worksheetNames": ["Sheet1", "Report"],
"worksheetIndexes": [1, 2],
"topMargin": 1.9,
"bottomMargin": 1.9,
"leftMargin": 1.9,
"rightMargin": 1.9,
"cultureName": "en-US"
}
}
Contoh Kode
Yang PDF4me Tambahkan Gambar Header Footer ke Excel REST API Menyediakan contoh kode dalam berbagai bahasa pemrograman. Pilih bahasa yang paling sesuai dengan lingkungan pengembangan Anda:
- C#
- Java
- JavaScript
- Python
C# (CSharp) Contoh
Menyelesaikan C# implementasi untuk menambahkan header/footer gambar ke Excel dokumen:
Java Contoh
Java Implementasi dengan penanganan kesalahan dan pemrosesan respons yang lengkap:
JavaScript Contoh
Node.js dan kompatibel dengan browser JavaScript implementasi:
Studi Kasus & Aplikasi Industri
- Finance & Accounting
- Sales & Marketing
- Human Resources
- Operations & Manufacturing
- Healthcare & Medical
- Legal & Professional Services
Studi Kasus Keuangan & Akuntansi
- Laporan KeuanganTambahkan header logo perusahaan ke laporan triwulanan.
- Laporan AnggaranSisipkan logo departemen pada lembar kerja anggaran.
- Dokumen Audit: Terapkan tanda air logo firma audit di bagian footer
- Laporan PengeluaranTambahkan header logo perusahaan untuk pengajuan pengeluaran.
Studi Kasus Penjualan & Pemasaran
- Laporan PenjualanSisipkan logo merek perusahaan pada laporan penjualan mingguan.
- Lembar HargaTambahkan header logo ke dokumen penetapan harga pelanggan.
- Laporan Pemasaran: Terapkan logo kampanye ke laporan analitik
- Presentasi PelangganTambahkan logo co-branding klien ke hasil akhir.
Studi Kasus Sumber Daya Manusia
- Laporan PenggajianSisipkan logo perusahaan pada dokumen gaji.
- Catatan KaryawanTambahkan logo departemen SDM ke templat kepegawaian.
- Pendaftaran Manfaat: Tempelkan logo penyedia manfaat pada formulir pendaftaran
- Tinjauan KinerjaTambahkan branding perusahaan ke templat ulasan.
Studi Kasus Operasi & Manufaktur
- Laporan Inventaris: Sisipkan logo lokasi gudang pada lembar inventaris
- Laporan ProduksiTambahkan logo fasilitas produksi ke laporan manufaktur.
- Laporan Kualitas: Cantumkan logo sertifikasi kualitas di bagian header
- Laporan Rantai PasokanTambahkan logo vendor ke dokumen pengadaan.
Kasus Penggunaan di Bidang Kesehatan & Medis
- Laporan PasienTambahkan header logo rumah sakit atau klinik ke data pasien.
- Hasil LaboratoriumSisipkan logo laboratorium pada lembar hasil tes.
- Klaim Asuransi: Cantumkan logo penyedia asuransi pada dokumen klaim
- Rekam medisTambahkan branding fasilitas ke lembar informasi kesehatan.
Studi Kasus Layanan Hukum & Profesional
- Laporan KlienSisipkan logo firma hukum pada header hasil pekerjaan klien.
- Dokumen KasusTambahkan logo bidang praktik ke berkas kasus hukum.
- Templat KontrakTerapkan branding perusahaan pada lembar kerja kontrak.
- Laporan TagihanSisipkan logo perusahaan pada laporan penagihan hukum.