Consulter votre quota
Ce que renvoie ce point de terminaison
Un appel indique la situation du mois : pages incluses, pages consommées et autorisation de dépassement. Il est destiné à votre tableau de bord et au contrôle précédant un traitement par lots.
Consulte votre quota mensuel, la consommation et l’état des dépassements pour les afficher dans votre tableau de bord.
curl https://api.pdfgine.com/api/v1/usage \
-H "X-PDFgine-Key: $PDFGINE_KEY"{
"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"
}Champ par champ
Tous les compteurs concernent le mois de facturation en cours et sont réinitialisés au début du suivant.
| Champ | Signification |
|---|---|
monthlyPageQuota | Pages incluses dans l’offre ce mois-ci. |
usedPages | Pages produites depuis le début du mois. |
quotaRemaining | monthlyPageQuota moins usedPages au moment de cette réponse. |
monthlyPreviewPageAllowance | Pages d’aperçu incluses en plus du quota de pages ; un aperçu ne consomme pas le quota de production. |
allowsOverage | Indique si les rendus continuent une fois le quota épuisé. Si false, le rendu suivant répond 402. |
monthlyOverageCap | Dépassement maximal du quota pour les rendus lorsque le dépassement est autorisé. |
meteringBasis | Définition d’une page pour la facturation. pdf-equivalent compte une sortie docx ou html comme le nombre de pages qu’aurait le PDF. |
Personnes et filiales
Deux autres limites sont incluses dans l’offre et comptées par organisation : le nombre de personnes dans l’espace de travail et le nombre de filiales qu’il peut gérer.
| Offre | Personnes | Filiales |
|---|---|---|
| Gratuit | 2 | 0 |
| Go | 3 | 0 |
| Pro | 10 | 5 |
| Max | Illimité | Illimité |
Une invitation dépassant la limite de places est refusée à l’envoi, pas à l’acceptation ; personne ne perd ainsi du temps sur une invitation qui ne pourrait jamais fonctionner.
Les problèmes les plus courants
- N’appelez pas ce point de terminaison après chaque rendu. Chaque rendu fournit déjà X-PDFgine-Quota-Remaining, soit le même nombre sans un second aller-retour.
- Les aperçus et les rendus de production sont comptés séparément. Un aperçu qui n’a pas modifié usedPages n’a pas échoué ; il a modifié usedPreviewPages.
- allowsOverage à false et un quota épuisé signifient 402 au rendu suivant, pas une file plus lente. Surveillez quotaRemaining plutôt que l’erreur.
- Le quota et la limite de débit sont deux limites distinctes. Une clé peut appeler 120 fois par 60 secondes quel que soit le quota restant ; au-delà, la réponse est 429 avec Retry-After.
- Les compteurs suivent le mois de facturation, pas le mois civil. Pour une offre achetée le 12, le mois se renouvelle le 12.