Guida al prodotto e alle API
Leggi la quota
Cosa restituisce questo endpoint
Una chiamata mostra la situazione del mese: pagine incluse, pagine consumate e possibilità di superare la quota. Serve per la tua dashboard e per i controlli prima di un processo in blocco.
Legge quota mensile, consumo e stato dell'utilizzo extra, da mostrare nella tua dashboard.
Richiesta
curl https://api.pdfgine.com/api/v1/usage \
-H "X-PDFgine-Key: $PDFGINE_KEY"
Risposta
{
"organizationName": "Northwind Trading Ltd.",
"planCode": "business",
"monthlyPageQuota": 5000,
"usedPages": 1284,
"quotaRemaining": 3716,
"monthlyPreviewPageAllowance": 250,
"usedPreviewPages": 32,
"allowsOverage": true,
"monthlyOverageCap": 1000,
"overagePages": 0,
"meteringBasis": "pdf-equivalent"
}Campo per campo
Ogni conteggio riguarda il mese di fatturazione corrente e si azzera al suo rinnovo.
| Campo | Significato |
|---|---|
monthlyPageQuota | Pagine incluse nel piano per questo mese. |
usedPages | Pagine prodotte finora questo mese. |
quotaRemaining | monthlyPageQuota meno usedPages al momento della risposta. |
monthlyPreviewPageAllowance | Pagine di anteprima incluse oltre alla quota di pagine; un'anteprima non consuma la quota di produzione. |
allowsOverage | Indica se la generazione continua a quota esaurita. Se false, la generazione successiva risponde 402. |
monthlyOverageCap | Quanto può essere superata la quota quando è consentito l'utilizzo extra. |
meteringBasis | Cosa significa una pagina ai fini della fatturazione. pdf-equivalent conta un output docx o html con lo stesso numero di pagine che avrebbe il PDF. |
Persone e aziende figlie
Il piano include altri due limiti, conteggiati per tenant: quante persone possono far parte dello spazio di lavoro e quante aziende figlie può gestire.
| Piano | Persone | Aziende figlie |
|---|---|---|
| Gratuito | 2 | 0 |
| Go | 3 | 0 |
| Pro | 10 | 5 |
| Max | Illimitato | Illimitato |
Un invito oltre il limite di posti viene rifiutato all'invio, non all'accettazione, così nessuno perde tempo con un invito che non potrebbe mai funzionare.
Gli errori più comuni
- Non chiamare questo endpoint dopo ogni generazione. Ogni generazione restituisce già X-PDFgine-Quota-Remaining, lo stesso numero senza una seconda richiesta.
- Anteprime e generazioni di produzione vengono conteggiate separatamente. Un'anteprima che non cambia usedPages non è fallita: ha cambiato usedPreviewPages.
- allowsOverage false e quota esaurita significano 402 alla generazione successiva, non una coda più lenta. Controlla quotaRemaining, non aspettare l'errore.
- Quota e limite di frequenza sono limiti diversi. Una chiave può chiamare 120 volte ogni 60 secondi, indipendentemente dalla quota rimasta; oltre il limite la risposta è 429 con Retry-After.
- I contatori seguono il mese di fatturazione, non quello solare. Per un piano acquistato il giorno 12, il mese si rinnova il 12.