Tek Belge Oluştur
Oluştur → Tek Belge Oluştur
O Tek Belge Oluştur API Şablon ve verilerden tek bir belge oluşturur. Şablonu gönderirsiniz (templateFileType, templateFileName, templateFileData Base64), documentDataType (metin, JSON, XML), outputType (html, PDF(Word, Excel), documentDataText veya documentDataFile, isteğe bağlı fileMetaData Ve metaDataJson, Ve async. O API Oluşturulan belgeyi döndürür (ikili veya sorgulama). URLAşağıdaki test aracını kullanarak deneyebilirsiniz; daha fazla ayrıntı sonraki bölümlerde yer almaktadır.
Tek Belge Oluştur seçeneğini deneyin. API
:::not Hızlı referans
Uç nokta: POST /api/v2/GenerateDocumentSingle · Gerekli: api-key, templateFileType, templateFileName, templateFileData, documentDataType, outputType, documentDataText
:::
:::bilgi Canlı olarak deneyin Aşağıdaki formu kullanarak gönderin API anahtar, şablon dosyası (Base64), veri türü, çıktı türü ve veri (JSON/XML (metin veya dosya). Yanıt, oluşturulan belgedir. Kod gerekmez, alanları doldurun ve tıklayın. İstek gönder.
:::
Genel Bakış, Parametreler ve Kullanım Örnekleri
- Overview
- Parameters
- Use cases
Tekli Belge Oluşturma nedir?
Bu uç nokta, bir şablondan (Word, HTML, veya PDF) ve veriler (JSON veya XMLŞablon dosyasını siz sağlıyorsunuz (Base64), templateFileType Ve templateFileName, documentDataType (metin, JSON, XML), outputType (html, PDF(Word, Excel) ve veriler aracılığıyla documentDataText veya documentDataFile. O API Verileri şablona entegre eder ve oluşturulan belgeyi döndürür. İsteğe bağlı kullanım. fileMetaData Ve metaDataJson Ek meta veriler için.
Başlıca özellikler
- Şablon türleri: Kelime, HTML, veya PDF şablonlar (Base64).
- Veri: documentDataType: metin, JSON, veya XML; veriler içinde documentDataText veya documentDataFile (Base64).
- Çıktı: outputType: html, PDFWord veya Excel.
- Asenkron: Kullanmak async Büyük şablonlar veya veriler için.
:::ipucu En iyi kullanım alanı: Her aramada tek bir belgeye (faturalar, mektuplar, raporlar) ihtiyacınız olduğunda kullanın. Tek bir şablondan birçok belge için şunu kullanın: Birden fazla belge oluştur.
:::
API parametreler
| Parametre | Tip | Gerekli | Tanım |
|---|---|---|---|
| api-key | sicim | Evet | Senin PDF4me API anahtar, Base64 Kodlanmış. Şuradan alın: gösterge paneli. |
| templateFileType | sicim | Evet | HTML, Word, PDF, HTML, veya DOCX. |
| templateFileName | sicim | Evet | Şablon dosyasının adı ve uzantısı (örneğin, invoice_template.html). |
| templateFileData | base64 | Evet | Şablon dosyasının içeriği (Base64). |
| documentDataType | sicim | Evet | metin, JSON, veya XML. |
| outputType | sicim | Evet | HTML, PDFWord, Excel veya HTML. |
| documentDataText | sicim | Evet | JSON/XML Veriler metin olarak (eğer documentDataFile (Verilmedi). |
| documentDataFile | base64 | HAYIR | Veri dosyası (Base64), alternatif olarak documentDataText. |
| fileMetaData, metaDataJson | sicim | HAYIR | Ek meta veriler. |
| async | mantıksal | HAYIR | Asenkron işlemeyi etkinleştirin. |
Tekli Belge Oluşturma özelliğini ne zaman kullanmalısınız?
- Faturalar ve mektuplarŞablon başına (fatura, sözleşme, mektup) birleştirilmiş verilerle tek bir belge oluşturun.
- RaporlarŞablon kullanarak tek bir rapor oluşturun ve JSON/XML veri.
- Sertifikalar: Her arama için bir sertifika veya belge oluşturun.
:::bilgi Tamamına ihtiyaç var API?
İstek/yanıt şemaları ve kod örnekleri için bakınız: Tek Belge Oluştur içinde PDF4me API belgeler.
:::
Önkoşullar
Bu uç noktayı kullanmadan önce şunlara sahip olduğunuzdan emin olun:
- Geçerli bir PDF4me API anahtar (Alın API Anahtar)
- Bir şablon dosyası (Word, HTML, veya PDF) içinde Base64 format
- Veriler JSON veya XML format
Yanıt Formatı
O API Oluşturulan belgeyi eşzamanlı işleme için ikili veri olarak döndürür (200 OK) veya bir anket sağlar URL eşzamansız işlem için (202) Accepted).