تخطَّ إلى المحتوى
ساعيv1

الحساب والاستهلاك

عرض بصيغة Markdown

تحقّق من مفتاحك وما يستطيع فعله.

نقاط الواجهة

تحقّق من مفتاح API

gethttps://api.saei.automize.sa/v1/me
  • الصلاحية: أي مفتاح صالح
  • يعمل في وضع الاختبار

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

حقول الاستجابة200
  • object"api_key_context"مطلوب
  • livemodebooleanمطلوب

    false لمفتاح الاختبار: الإرسال محاكاة ولا يصل إلى واتساب.

  • workspaceobjectمطلوب
    الحقول الفرعية (2)
    • idstringمطلوب
    • namestring | nullمطلوب
  • api_keyobjectمطلوب
    الحقول الفرعية (5)
    • idstringمطلوب
    • namestringمطلوب
    • prefixstringمطلوب
    • scopesarray<string>مطلوب
    • expires_atstring | nullاختياري
  • rate_limitobjectمطلوب
    الحقول الفرعية (2)
    • limitintegerمطلوب
    • window_secondsintegerمطلوب
الأخطاء المحتملة5
جرّبها
curl -X GET https://api.saei.automize.sa/v1/me \
  -H "Authorization: Bearer $API_KEY"
الاستجابة

المفتاح يعمل.

{
  "object": "api_key_context",
  "livemode": false,
  "workspace": {
    "id": "ws_12",
    "name": "Riyadh Coffee"
  },
  "api_key": {
    "id": "key_7",
    "name": "Order system",
    "prefix": "sk_test_Ab12Cd",
    "scopes": [
      "messages:send",
      "messages:read",
      "webhooks:read",
      "webhooks:write"
    ],
    "expires_at": null
  },
  "rate_limit": {
    "limit": 60,
    "window_seconds": 60
  }
}

جلب الاستهلاك

gethttps://api.saei.automize.sa/v1/usage
  • الصلاحية: usage:read
  • يعمل في وضع الاختبار

ما استهلكته مساحة العمل في فترة الفوترة الحالية مقارنة بباقتها (الرسائل التسويقية والخدمية، الحملات، جهات الاتصال، القوالب، التدفقات، الأرقام)، وكيف استُدعيت الواجهة في وضع هذا المفتاح خلال آخر 30 يومًا.

تحقق من remaining قبل إرسال كبير لتتجنب quota_exceeded. تكون limit وremaining بقيمة null للرصيد غير المحدود.

حقول الاستجابة200
  • object"usage"مطلوب
  • periodobjectمطلوب
    الحقول الفرعية (2)
    • startstringاختياري
    • endstringاختياري
  • allowancesarray<object>مطلوب
    الحقول الفرعية (5)
    • keystringمطلوب

      مثل marketing_messages_month وservice_messages_month وcampaigns_month وcontacts وmessage_templates وactive_flows وwhatsapp_numbers.

    • typestringمطلوب

      monthly يُعاد ضبطه كل فترة فوترة، وtotal يحسب الموجود حاليًا.

      إحدى القيمmonthlytotal

    • usedintegerمطلوب
    • limitinteger | nullاختياري
    • remaininginteger | nullاختياري
  • apiobjectمطلوب
    الحقول الفرعية (6)
    • livemodeboolean | nullاختياري
    • window_daysintegerاختياري
    • requestsintegerاختياري
    • errorsintegerاختياري
    • error_ratenumberاختياري
    • by_dayarray<object>اختياري
      الحقول الفرعية (3)
      • datestringاختياري
      • requestsintegerاختياري
      • errorsintegerاختياري
الأخطاء المحتملة1
جرّبها
curl -X GET https://api.saei.automize.sa/v1/usage \
  -H "Authorization: Bearer $API_KEY"
الاستجابة

تقرير الاستهلاك.

{
  "object": "usage",
  "period": {
    "start": "2026-10-01T00:00:00Z",
    "end": "2026-11-01T00:00:00Z"
  },
  "allowances": [
    {
      "key": "marketing_messages_month",
      "type": "monthly",
      "used": 4120,
      "limit": 10000,
      "remaining": 5880
    },
    {
      "key": "service_messages_month",
      "type": "monthly",
      "used": 18230,
      "limit": null,
      "remaining": null
    },
    {
      "key": "contacts",
      "type": "total",
      "used": 9214,
      "limit": 25000,
      "remaining": 15786
    }
  ],
  "api": {
    "livemode": true,
    "window_days": 30,
    "requests": 48213,
    "errors": 212,
    "error_rate": 0.0044,
    "by_day": [
      {
        "date": "2026-09-30",
        "requests": 1804,
        "errors": 6
      }
    ]
  }
}