Belge üret

Bu uç ne yapar

Tek bir çağrı, şablonu ve verinizi bitmiş bir dosyaya çevirir. Belge siz beklerken üretilir ve yanıt indirme adresini taşır; yoklanacak bir şey yoktur. Uzun belgeler ve toplu iş için kuyruk ucu aynı işi arka planda yapar.

Şablon kodunu ve verinizi gönderin, belgeyi geri alın. Cevabın indirme bağlantısı temel adrese görecelidir ve aynı API anahtarıyla çağrılır.

curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "locale": "tr",
        "purpose": "production",
        "data": {
          "document": { "title": "INV-2026-001" }
        }
      }'

format alanı "pdf" veya "docx" alır. Eski istemciler için sayısal değerler de çalışır: 1 PDF, 2 DOCX. Yanıtlarda format sayı olarak döner.

purpose alanı production olduğunda kotadan düşer. Şablonu denerken editor-test gönderin; bu çıktı kotayı tüketmez ve yayınlanmamış taslak sürümü kullanır.

Gidiş dönüşün tamamı

Yukarıdaki çağrının yanıtı ve dosyayı çeken çağrı. Durum 202: istek kabul edildi ve belge hazır.

HTTP/1.1 202 Accepted
X-PDFgine-Pages: 1
X-PDFgine-Quota-Remaining: 4999

{
  "documentId": "doc_a96063f5dcd5400286ce9b3be9b0595b",
  "format": "pdf",
  "templateCode": "invoice",
  "templateVersion": 1,
  "templateVersionSource": "published",
  "downloadUrl": "/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf",
  "pageCount": 1,
  "quotaRemaining": 4999,
  "meteringBasis": "pdf-equivalent"
}

curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -o invoice.pdf

Sık takılınan yerler

• Üretim 200 değil 202 döner. 200 dışındaki her şeyi başarısızlık sayan bir istemci, başarıyı hata olarak raporlar.
• purpose iki şeyi birden belirler: production yayımlanmış sürümü kullanır ve kotadan düşer, editor-test yayımlanmamış taslağı kullanır ve kotaya hiç dokunmaz. Şablon denemenin en pahalı yolu production ile denemektir.
• 422 sunucu hatası değildir. Gövde, şablonun beklediği her alanı errors altında sayar; çözüm yeniden denemek değil, gönderdiğiniz veridedir.
• 402, aylık sayfa kotasının bittiği anlamına gelir. X-PDFgine-Quota-Remaining başlığı oraya varmadan önce size söyler.
• downloadUrl, API adresine göredir. Onu mutlak adres olarak saklamak, adres değiştiği gün kırılır; documentId'yi saklayın, adresi siz kurun.