قراءة حصتك

ما يعيده هذا الطرف النهائي

يخبرك استدعاء واحد بحالة الشهر: الصفحات المشمولة والمستهلكة وما إذا كان التجاوز مسموحًا. صُمم للوحة معلوماتك وللفحص قبل مهمة جماعية.

يقرأ حصتك الشهرية واستهلاكك وحالة التجاوز، لعرضها ضمن لوحة معلوماتك.

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"
}

حقلًا بحقل

تخص جميع العدادات شهر الفوترة الحالي وتُصفّر عند بدء الشهر التالي.

الأشخاص والشركات التابعة

تأتي مع الخطة حدود إضافية تُحسب لكل مستأجر: عدد الأشخاص في مساحة العمل، وعدد الشركات التابعة التي يمكنها إدارتها.

تُرفض الدعوة التي تتجاوز حد المقاعد عند إرسالها، لا عند قبولها، فلا يضيع أحد وقته على دعوة لا يمكن أن تنجح.

الأخطاء الشائعة

• لا تستدعِ هذا الطرف بعد كل إنشاء. يعيد كل إنشاء X-PDFgine-Quota-Remaining بالفعل، وهو الرقم نفسه دون دورة طلب إضافية.
• تُحسب المعاينات وإنشاءات الإنتاج بشكل منفصل. المعاينة التي لم تغير usedPages لم تفشل؛ بل غيرت usedPreviewPages.
• تعني allowsOverage بالقيمة false مع نفاد الحصة الحالة 402 في الإنشاء التالي، لا قائمة أبطأ. راقب quotaRemaining بدل انتظار الخطأ.
• الحصة وحد المعدل حدان مختلفان. يمكن للمفتاح الاستدعاء 120 مرات كل 60 ثانية مهما كانت الحصة المتبقية؛ وبعدها تكون الاستجابة 429 مع Retry-After.
• تتبع العدادات شهر الفوترة لا الشهر التقويمي. لخطة اشتُريت يوم 12 يبدأ الشهر التالي يوم 12.