Tambahkan Lampiran ke PDF - Penyematan File API
PDF4me Tambahkan Lampiran ke PDF memungkinkan Anda untuk menambahkan lampiran file ke PDF dokumen, membuat paket dokumen komprehensif dengan file yang disematkan. Ini API proses layanan PDF dokumen dan berbagai jenis file lampiran, menyematkannya langsung ke dalam PDFs. Itu API menerima sumber PDF file dan file lampiran melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi file yang aman. Dengan dukungan untuk berbagai jenis file dan pemrosesan lampiran secara massal, solusi ini ideal untuk sistem manajemen dokumen, alur kerja perusahaan, dan aplikasi bisnis yang membutuhkan keandalan. PDF fungsi lampiran.
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
- Berbagai Jenis File: Mendukung berbagai format file lampiran termasuk teks, gambar, dan dokumen
- Lampiran BatchTambahkan beberapa lampiran ke satu dokumen. PDF dokumen
- Base64 Pengkodean: Transmisi konten file yang aman menggunakan Base64 pengkodean
- Pelestarian Dokumen: Mempertahankan aslinya PDF struktur sambil menambahkan lampiran
- Penamaan FleksibelSesuaikan nama lampiran untuk pengorganisasian yang lebih baik.
- Pengemasan ProfesionalBuat paket dokumen komprehensif dengan sumber daya terintegrasi.
REST API Titik akhir
Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi penambahan lampiran dilakukan melalui satu titik akhir:
- Metode: POST
- Titik akhir:
/api/v2/AddAttachmentToPdf
REST API Parameter
Daftar lengkap parameter untuk Menambahkan Lampiran 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... |
| lampiran* | Array | Array objek lampiran untuk disematkan di dalam PDFSetiap objek harus berisi docName (tali) dan docContent (string base64) | Lihat contoh di bawah ini. |
Struktur Objek Lampiran
Setiap item dalam attachments Array harus berupa objek dengan struktur berikut:
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| Nama dokumen | String | Nama file lampiran beserta ekstensinya (misalnya, .txt, .pdf, .jpg, dll.) | attachment.txt |
| Konten dokumen | Base64 | Isi file lampiran yang dikodekan dalam Base64 | RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA== |
Parameter Opsional
| Parameter | Jenis | Keterangan | Contoh |
|---|---|---|---|
| asinkron | Boolean | Aktifkan pemrosesan asinkron. Saat true, itu API mengembalikan status 202 dan menyediakan polling URL di dalam Location judul | true |
Keluaran
Yang PDF4me Tambahkan Lampiran 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
Tipe Konten: 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 lampiran tersemat, 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 Diterima
Header Respons:
Location: https://api.pdf4me.com/api/v2/AddAttachmentToPdf/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,lampiran) - Tidak sah Base64 pengkodean dalam
Konten dokumenatau lampiranKonten dokumen - Struktur objek lampiran tidak valid
- 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
- Kegagalan penyematan lampiran
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
}
Header Content-Type:
- 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
Lampiran Tunggal:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"attachments": [
{
"docName": "output.txt",
"docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
}
]
}
Beberapa Lampiran:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"attachments": [
{
"docName": "file1.txt",
"docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
},
{
"docName": "file2.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MK..."
}
],
"async": true
}
Contoh Kode
Yang PDF4me Tambahkan Lampiran 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
Java Contoh
Java Implementasi dengan penanganan kesalahan dan pemrosesan respons yang lengkap:
JavaScript Contoh
Node.js dan kompatibel dengan browser JavaScript implementasi:
PDF Fitur Lampiran
Pemrosesan Lampiran
- Berbagai Jenis FileDukungan untuk berbagai format lampiran termasuk file teks (.txt, .csv, .log), dokumen (.pdf, .doc, .docx, .xls, .xlsx), gambar (.jpg, .jpeg, .png, .gif), arsip (.zip, .rar), dan jenis file lainnya.
- Pemrosesan BatchTambahkan beberapa lampiran ke satu dokumen. PDF mendokumentasikan dalam satu operasi dengan menyediakan serangkaian objek lampiran.
- Base64 Pengkodean: Transmisi konten file yang aman menggunakan Base64 pengkodean
- Penamaan FileSetiap lampiran harus menyertakan
docNamedengan ekstensi file yang sesuai
Peningkatan Dokumen
- PDF Pelestarian: Mempertahankan aslinya PDF struktur dan konten saat menambahkan lampiran
- Pengorganisasian File: Penamaan dan pengorganisasian lampiran tersemat secara khusus melalui
docNamebidang - Portabilitas DokumenBuat paket dokumen mandiri dengan semua file terkait yang tertanam di dalamnya. PDF
- Pengemasan Profesional: Menghasilkan paket dokumen komprehensif untuk didistribusikan
Penanganan Respons
- Pemrosesan SinkronSecara default, API memproses permintaan secara sinkron dan mengembalikan PDF dengan lampiran (status 200)
- Pemrosesan Asinkron: Mengatur
async: trueuntuk memungkinkan pemrosesan asinkron. Yang API mengembalikan status 202 dengan polling URL di dalam Location judul - Respons Biner: Itu API mengembalikan PDF file sebagai konten biner (application/pdf) bila berhasil
Studi Kasus & Aplikasi Industri
- Legal & Professional Services
- Education & Research
- Business & Enterprise
- Technology & Development
Studi Kasus Layanan Hukum & Profesional
- Dokumentasi HukumSertakan berkas bukti, kontrak, dan dokumen pendukung.
- Berkas PengadilanLampirkan dokumen pendukung pada berkas pengadilan dan ringkasan hukum.
- Dokumentasi Klien: Kemas dokumen klien beserta materi pendukungnya
- Dokumentasi KepatuhanSertakan sertifikat, izin, dan dokumen peraturan.
Studi Kasus Pendidikan & Penelitian
- Makalah AkademikSertakan kumpulan data, materi penelitian, dan informasi tambahan.
- Dokumentasi PenelitianLampirkan data penelitian dan materi tambahan.
- Pengajuan Tesis: Menyusun tesis beserta dokumen pendukung dan kumpulan data
- Materi PelatihanSisipkan sumber daya, latihan, dan panduan referensi.
Kasus Penggunaan Bisnis & Perusahaan
- Laporan BisnisLampirkan spreadsheet, grafik, dan file analisis terperinci.
- Hasil yang Diharapkan dari ProyekGabungkan semua file proyek ke dalam satu dokumen PDF.
- Paket DokumenBuat paket dokumen komprehensif dengan materi pendukung.
- Dokumentasi PerusahaanSertakan materi pendukung bersama dokumen perusahaan.
Studi Kasus Teknologi & Pengembangan
- Dokumentasi Teknis: Contoh kode sematan, file konfigurasi, dan materi referensi
- Dokumentasi Perangkat LunakLampirkan file kode dan spesifikasi teknis.
- Dokumentasi APISertakan contoh kode dan file konfigurasi.
- Sumber Daya PengembangSumber daya dan materi referensi untuk pengembang paket.