Buat Dokumen Berganda
Menghasilkan → Buat Dokumen Berganda
Yang Buat Dokumen Berganda API Menghasilkan beberapa dokumen dari satu templat dan beberapa item data. Anda mengirimkan templat (templateFileType, templateFileName, templateFileData Base64), documentDataType (Json atau XML), outputType (Docx, PDF, Word, Excel, HTML), documentDataText atau documentDataFile, opsional fileMetaData Dan metaDataJson, Dan async. Itu API pengembalian JSON dengan sebuah outputDocuments array (atau polling) URL Kapan asyncGunakan penguji di bawah ini untuk mencobanya; detail selengkapnya ada di bagian selanjutnya.
Coba opsi Hasilkan Dokumen Berganda API
:::catatan Referensi cepat
Titik akhir: POST /api/v2/GenerateDocumentMultiple · 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 JSON dengan dokumen yang dihasilkan. Tidak perlu kode, isi kolom dan klik. Kirim permintaan.
Gambaran umum, parameter, dan kasus penggunaan.
- Overview
- Parameters
- Use cases
Apa itu Menghasilkan Dokumen Berganda?
Endpoint ini menghasilkan beberapa dokumen dari satu template dan beberapa catatan data (JSON atau XML). Anda menyediakan templat (Word, HTML, atau PDF sebagai Base64), documentDataType (Json atau XML), outputType (Docx, PDF, Word, Excel, HTML), dan data melalui documentDataText atau documentDataFile. Itu API menghasilkan satu dokumen per catatan data dan mengembalikannya dalam bentuk outputDocuments array (atau polling) URL Kapan async).
Fitur utama
- Satu templat, banyak dokumen: Template yang sama digabungkan dengan setiap catatan data.
- Jenis templat: Docx, Kata, HTML, atau PDF (Base64).
- Data: documentDataType: Json atau XML; data di documentDataText atau documentDataFile.
- Keluaran: outputType: Docx, PDF, Word, Excel, atau HTML.
- Asinkron: Menggunakan async untuk jumlah besar.
Gunakan saat Anda membutuhkan banyak dokumen dari satu templat (surat massal, sertifikat, label). Untuk satu dokumen per panggilan, gunakan Hasilkan Dokumen Tunggal.
API parameter
| Parameter | Jenis | Diperlukan | Keterangan |
|---|---|---|---|
| api-key | rangkaian | Ya | Milikmu PDF4me API kunci, Base64 dikodekan. Dapatkan dari dasbor. |
| templateFileType | rangkaian | Ya | Docx, Kata, HTML, atau PDF. |
| templateFileName | rangkaian | Ya | Nama file templat beserta ekstensinya (misalnya sample.docx). |
| templateFileData | base64 | Ya | Isi file templat (Base64). |
| documentDataType | rangkaian | Ya | Json atau XML. |
| outputType | rangkaian | Ya | Docx, 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 Documents Multiple?
- Surat dan sertifikat kelompok: Menghasilkan banyak dokumen dari satu templat dengan data yang berbeda (surat, sertifikat, label).
- Laporan massal: Menghasilkan beberapa laporan dalam satu permintaan.
- Pengiriman surat massalGabungkan satu templat dengan daftar penerima atau baris data.
Untuk skema permintaan/respons dan contoh kode, lihat Buat Dokumen Berganda 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 pengembalian JSON dengan outputDocuments array yang berisi dokumen yang dihasilkan untuk pemrosesan sinkron (200 OK) atau menyediakan jajak pendapat URL untuk pemrosesan asinkron (202 Accepted).