آخر تحديث
الحساب
الباقة والحدود واستخدام الرصيد لمساحة العمل التي يتبع لها المفتاح.
تُصادَق كل عملية بمفتاح API (Authorization: Bearer <key>) وتستخدم الأخطاء الغلاف المشترك الموضّح في الأخطاء. مولَّد من مستند OpenAPI الخاص بواجهة API.
جلب الباقة والحدود
/v1/entitlementsباقة مساحة العمل ووحداتها وحدود المعدل ومحفظة الأرصدة لفترة فوترة: limits.watchlistMax وlimits.requestsPerMinute (طلبات مفاتيح API في الدقيقة لكل مفاتيح مساحة العمل معًا) وcredits.hardCap (أرصدة الباقة مضافًا إليها شحنات الفترة) وcredits.resetAt (موعد إعادة ضبط أرصدة الفترة) وexports (عمليات التصدير داخل التطبيق اليوم؛ perDay قيمته 0 في free وnull أي بلا حد في الباقات المدفوعة) وmoney (ماسة واحدة بالدولار الإجمالي التقديري وحصة صانع المحتوى وسعر صرف VND الشهري: تقديرات للعرض فقط، وليست أبدًا ما تدفعه TikTok).
معاملات الاستعلام
| Name | Type | Description |
|---|---|---|
periodOptional | string | بداية دورة الفوترة، YYYY-MM-01؛ والقيمة الافتراضية هي الدورة الحالية. |
الطلب
curl "https://api.next.toktokdata.live/v1/entitlements" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"الاستجابة
{ "data": { "workspaceId": "4388fdb0-ef68-5d01-ac84-b683b2b355e8", "planCode": "agency", "tier": "agency", "modules": [ "live", "lookup" ], "limits": { "requestsPerWindow": 150, "rateWindowMs": 1000, "apiRequestsPerSecond": 150, "requestsPerDay": 1200000, "requestsPerMinute": 9000, "maxApiKeys": 0, "wsConcurrencyCap": 200, "maxRoomMinutesPerMonth": 800000, "historyWindowDays": 365, "maxSeats": 10, "seatsUsed": 2, "exportFormats": [ "csv", "xlsx" ], "watchlistMax": 25 }, "credits": { "period": "2026-11-01", "monthlyAllotment": 36000000, "hardCap": 36000000, "spent": 0, "remaining": 0, "resetAt": "2026-12-01T00:00:00.000Z" }, "money": { "diamondUsdGross": 0.01, "creatorShare": 0.5, "vndPerUsd": 25500, "rateLabel": "estimate · 2026-11" }, "exports": { "perDay": null, "usedToday": 1 } }, "provenance": { "observedAt": "2026-11-01T11:19:24.411834Z", "freshness": "near_realtime", "source": "plan_entitlement", "sourceKind": "derived", "coverageStatus": "observed", "methodologyVersion": "entitlements-v1", "window": { "from": "2026-11-01", "to": "2026-12-01", "label": "2026-11" } }}الأخطاء
400معامل أو جسم طلب غير صالح؛ ويحددcodeالمشكلة.401مفتاح API مفقود أو غير معروف.403المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.429تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمةRetry-After.
جلب استخدام الرصيد
/v1/usageوحدات الرصيد المستهلكة لكل عملية في دورة فوترة.
معاملات الاستعلام
| Name | Type | Description |
|---|---|---|
periodOptional | string | بداية دورة الفوترة، YYYY-MM-01؛ والقيمة الافتراضية هي الدورة الحالية. |
limitOptional | integer | الحد الأقصى لعدد الصفوف. |
الطلب
curl "https://api.next.toktokdata.live/v1/usage" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"الاستجابة
{ "period": "2026-11-01", "balance": { "remaining": 0, "spent": 0 }, "items": [], "provenance": { "observedAt": "2026-11-01T10:00:00.000Z", "freshness": "near_realtime", "source": "credit_ledger", "sourceKind": "derived", "coverageStatus": "observed", "methodologyVersion": "usage-v1", "window": { "from": "2026-11-01", "to": "2026-12-01", "label": "2026-11" } }}الأخطاء
400معامل أو جسم طلب غير صالح؛ ويحددcodeالمشكلة.401مفتاح API مفقود أو غير معروف.403المفتاح يفتقر إلى النطاق، أو أن الباقة لا تتضمن الميزة.429تم تجاوز معدل الطلبات (في الثانية أو الدقيقة أو اليوم)؛ التزم بقيمةRetry-After.