Hasilkan Dokumen Tunggal
Menghasilkan → Hasilkan Dokumen Tunggal
Yang Hasilkan Dokumen Tunggal API Menghasilkan satu dokumen dari templat dan data. Anda mengirimkan templat (templateFileType, templateFileName, templateFileData Base64), documentDataType (teks, JSON, XML), outputType (html, PDF, Word, Excel), documentDataText atau documentDataFile, opsional fileMetaData Dan metaDataJson, Dan async. Itu API Mengembalikan dokumen yang dihasilkan (biner atau polling) URLGunakan penguji di bawah ini untuk mencobanya; detail selengkapnya ada di bagian selanjutnya.
Coba Hasilkan Dokumen Tunggal API
:::catatan Referensi cepat
Titik akhir: POST /api/v2/GenerateDocumentSingle · Diperlukan: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
:::
Gunakan formulir di bawah ini untuk mengirimkan API kunci, berkas templat (Base64), tipe data, tipe output, dan data (JSON/XML (teks atau file). Responsnya adalah dokumen yang dihasilkan. Tidak perlu kode, isi kolom dan klik. Kirim permintaan.
Gambaran umum, parameter, dan kasus penggunaan.
- Overview
- Parameters
- Use cases
Apa itu Generate Document Single?
Endpoint ini menghasilkan satu dokumen dari sebuah template (Word, HTML, atau PDF) dan data (JSON atau XML). Anda menyediakan file templat (Base64), templateFileType Dan templateFileName, documentDataType (teks, JSON, XML), outputType (html, PDF, Word, Excel), dan data melalui documentDataText atau documentDataFile. Itu API Menggabungkan data ke dalam templat dan mengembalikan dokumen yang dihasilkan. Gunakan opsi opsional. fileMetaData Dan metaDataJson untuk metadata tambahan.
Fitur utama
- Jenis templat: Kata, HTML, atau PDF templat (Base64).
- Data: documentDataType: teks, JSON, atau XML; data di documentDataText atau documentDataFile (Base64).
- Keluaran: outputType: html, PDF, Word, atau Excel.
- Asinkron: Menggunakan async untuk template atau data berukuran besar.
Gunakan saat Anda membutuhkan satu dokumen per panggilan (faktur, surat, laporan). Untuk banyak dokumen dari satu templat, gunakan Buat Dokumen Berganda.
API parameter
| Parameter | Jenis | Diperlukan | Keterangan |
|---|---|---|---|
| api-key | rangkaian | Ya | Milikmu PDF4me API kunci, Base64 dikodekan. Dapatkan dari dasbor. |
| templateFileType | rangkaian | Ya | html, Word, PDF, HTML, atau DOCX. |
| templateFileName | rangkaian | Ya | Nama file templat beserta ekstensinya (misalnya invoice_template.html). |
| templateFileData | base64 | Ya | Isi file templat (Base64). |
| documentDataType | rangkaian | Ya | teks, JSON, atau XML. |
| outputType | rangkaian | Ya | html, PDF, Word, Excel, atau HTML. |
| documentDataText | rangkaian | Ya | JSON/XML data sebagai teks (jika documentDataFile (tidak disediakan). |
| documentDataFile | base64 | TIDAK | Berkas data (Base64), alternatif untuk documentDataText. |
| fileMetaData, metaDataJson | rangkaian | TIDAK | Metadata tambahan. |
| async | boolean | TIDAK | Aktifkan pemrosesan asinkron. |
Kapan menggunakan Generate Document Single?
- Faktur dan surat: Menghasilkan satu dokumen per templat (faktur, kontrak, surat) dengan data yang digabungkan.
- Laporan: Menghasilkan satu laporan dari sebuah templat dan JSON/XML data.
- Sertifikat: Menghasilkan satu sertifikat atau dokumen per panggilan.
Untuk skema permintaan/respons dan contoh kode, lihat Hasilkan Dokumen Tunggal di dalam PDF4me API dokumen.
Prasyarat
Sebelum menggunakan endpoint ini, pastikan Anda telah:
- Sebuah valid PDF4me API kunci (Dapatkan milikmu API Kunci)
- Berkas templat (Word, HTML, atau PDF) di dalam Base64 format
- Data di JSON atau XML format
Format Respons
Yang API mengembalikan dokumen yang dihasilkan sebagai data biner untuk pemrosesan sinkron (200 OK) atau menyediakan jajak pendapat URL untuk pemrosesan asinkron (202 Accepted).