Ürün ve API rehberi
Kota sorgula
Bu uç neyi söyler
Tek bir çağrı ayın nerede olduğunu söyler: planın kaç sayfa içerdiğini, kaçının harcandığını ve aşımın açık olup olmadığını. Kendi panelinizde göstermek ve toplu bir işten önce bakmak için tasarlandı.
Aylık kotanızı, tüketiminizi ve aşım durumunuzu okur. Kendi panonuzda göstermek için uygundur.
İstek
curl https://api.pdfgine.com/api/v1/usage \
-H "X-PDFgine-Key: $PDFGINE_KEY"
Cevap
{
"organizationName": "Acme Teknoloji A.Ş.",
"planCode": "business",
"monthlyPageQuota": 5000,
"usedPages": 1284,
"quotaRemaining": 3716,
"monthlyPreviewPageAllowance": 250,
"usedPreviewPages": 32,
"allowsOverage": true,
"monthlyOverageCap": 1000,
"overagePages": 0,
"meteringBasis": "pdf-equivalent"
}
Alan alan
Her sayaç içinde bulunulan fatura ayına aittir ve ay döndüğünde sıfırlanır.
| Alan | Ne anlama gelir |
|---|---|
monthlyPageQuota | Planın bu ay içerdiği sayfa. |
usedPages | Bu ay şimdiye kadar üretilen sayfa. |
quotaRemaining | Bu yanıt anında monthlyPageQuota eksi usedPages. |
monthlyPreviewPageAllowance | Planın sayfa kotasının üstüne verdiği önizleme sayfası; önizleme üretim kotasını yemez. |
allowsOverage | Kota bittikten sonra üretimin sürüp sürmeyeceği. false ise bir sonraki üretim 402 döner. |
monthlyOverageCap | Aşım açıkken üretimin kotanın ne kadar üstüne çıkabileceği. |
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. |
Kişi ve alt firma
Planla gelen iki tavan daha var ve ikisi de kiracı başına sayılıyor: çalışma alanında kaç kişi olabileceği ve kaç alt firma yönetilebileceği.
| Plan | Kişi | Alt firma |
|---|---|---|
| Ücretsiz | 2 | 0 |
| Go | 3 | 0 |
| Pro | 10 | 5 |
| Max | Sınırsız | Sınırsız |
Koltuk sınırını aşan bir davet kabul edilirken değil gönderilirken reddediliyor — böylece hiç işe yaramayacak bir davete kimse zaman harcamıyor.
Sık takılınan yerler
- Bu ucu her üretimden sonra çağırmayın. Her üretim zaten X-PDFgine-Quota-Remaining başlığıyla aynı sayıyı veriyor; ikinci bir gidiş dönüşe gerek yok.
- Önizlemeler ile üretimler ayrı sayılır. usedPages'i oynatmayan bir önizleme başarısız olmamıştır; usedPreviewPages'i oynatmıştır.
- allowsOverage false ve kota bittiyse sonuç yavaş bir kuyruk değil, sonraki üretimde 402'dir. Hatayı değil quotaRemaining'i izleyin.
- Kota ile hız sınırı farklı tavanlardır. Bir anahtar, kotası ne kadar olursa olsun 60 saniyede 120 çağrı yapabilir; üstünde yanıt Retry-After taşıyan 429'dur.
- Sayaçlar takvim ayını değil fatura ayını izler. Ayın 12'sinde alınmış bir planda ay 12'sinde döner.