Ürün ve API rehberi
Cevap
Ne geri gelir
Başarılı her üretim aynı nesneyi döndürür. İki alanı saklamaya değer: documentId dosyayı saklandığı süre boyunca tanımlar, pageCount ise ayın faturalandığı birimdir.
Cevap
{
"documentId": "doc_5bd26de32c324a4bb8cffad2c80edd01",
"jobId": "job_00b96f006b034258b00b650d724d0207",
"fileName": "invoice-doc_5bd26de32c324a4bb8cffad2c80edd01.pdf",
"format": "pdf",
"templateCode": "invoice",
"templateVersion": 5,
"templateVersionSource": "published",
"downloadUrl": "/api/v1/documents/doc_5bd2.../download/pdf",
"previewUrl": null,
"pageCount": 1,
"quotaRemaining": 4999,
"meteringBasis": "pdf-equivalent",
"createdAt": "2026-08-28T13:23:32+00:00"
}Normal üretim özel kalır ve indirme için API anahtarınızı ister. Yalnızca müşteriniz için süreli bir bağlantı paylaşmak istediğinizde önizleme endpointini kullanın.
Cevap başlıkları
Her üretim cevabı ölçüm bilgisini başlıkta da taşır; kotayı ayrı bir çağrı yapmadan izleyebilirsiniz.
X-PDFgine-Pages | Bu belgenin sayfa sayısı |
|---|---|
X-PDFgine-Job | Üretim işinin kimliği |
X-PDFgine-Quota-Remaining | İşlemden sonra kalan sayfa |
X-PDFgine-Metering-Basis | Ölçüm birimi |
Alan alan
pdf, docx ve html için aynı alanlar döner; yalnız fileName değişir.
| Alan | Ne anlama gelir |
|---|---|
documentId | Üretilen dosyanın kimliği. İndirme, durum ve paylaşma hep onun üzerinden gider; saklanmaya değer tek değer budur. |
downloadUrl | API adresine görelidir ve aynı anahtarla çekilir. Bir yol adresidir, herkese açık bir bağlantı değil. |
templateVersion | Bu dosyayı şablonun hangi sürümünün ürettiği. Saklarsanız aylar sonraki bir yeniden basım açıklanabilir olur. |
templateVersionSource | Üretimde published; purpose editor-test ise draft. |
pageCount | Kaç sayfa üretildiği; kotanın saydığı budur. |
quotaRemaining | Bu yanıt anında ay içinde kalan sayfa. |
meteringBasis | Faturalamada bir sayfanın ne demek olduğu. pdf-equivalent, docx ya da html çıktısını PDF'in olacağı sayfa sayısıyla sayar. |
previewUrl | Yalnız belge paylaşıldığında dolar; aksi hâlde null. |
Sık takılınan yerler
- downloadUrl bir yoldur. API adresi ve anahtar olmadan tarayıcıya yapıştırınca dosya değil 404 ya da 401 gelir.
- Yanıtın tamamını değil documentId'yi saklayın. Saklama süresi dolduğunda dosya silinir ve kayıtlı bir adres boşluğu gösterir.
- quotaRemaining o anın fotoğrafıdır, canlı bir sayaç değil. Aynı anda giden iki çağrı aynı sayıyı okuyabilir.
- pageCount faturalama birimidir, dosya sayısı değil. On sayfalık bir belge pdf de isteseniz docx de isteseniz on sayfadır.
- previewUrl'in null olması paylaşımın başarısız olduğu anlamına gelmez; bu üretim paylaşılmamıştır. Paylaşma ayrı bir çağrıdır.