RoomScope

Son güncelleme

Hesap

Anahtarın çalışma alanının planı, limitleri ve kredi kullanımı.

Her işlemde kimlik doğrulama bir API anahtarıyla yapılır (Authorization: Bearer <key>) ve hatalar şu sayfada açıklanan ortak zarfı kullanır: Hatalar. API’nin OpenAPI belgesinden üretilmiştir.

Plan ve limitleri alma

GET/v1/entitlements

Bir faturalandırma dönemi için çalışma alanının planı, modülleri, istek limitleri ve kredi cüzdanı: limits.watchlistMax, credits.resetAt (dönemin kredilerinin sıfırlandığı zaman) ve exports (bugün için uygulama içi dışa aktarmalar; günlük bir üst sınır uygulanmadığı sürece perDay null olur) ve money (tahmini brüt USD cinsinden 1 elmas, içerik üreticisinin payı ve aylık VND kuru: gösterim amaçlı tahminlerdir, asla TikTok’un ödemesi değildir).

Kapsamkeys:manageKredilerÜcretsiz

Sorgu parametreleri

Sorgu parametreleri · GET /v1/entitlements
NameTypeDescription
periodOptional
stringFaturalandırma döneminin başlangıcı, YYYY-MM-01; varsayılan olarak mevcut dönem.

İstek

curl "https://api.toktokdata.live/v1/entitlements" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Yanıt

200 OK
{  "data": {    "workspaceId": "4388fdb0-ef68-5d01-ac84-b683b2b355e8",    "planCode": "agency",    "tier": "agency",    "modules": [      "live",      "lookup"    ],    "limits": {      "requestsPerWindow": 150,      "rateWindowMs": 1000,      "apiRequestsPerSecond": 150,      "requestsPerDay": 1200000,      "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"    }  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.

Kredi kullanımını alma

GET/v1/usage

Bir faturalandırma döneminde işlem başına harcanan krediler.

Kapsamkeys:manageKredilerÜcretsiz

Sorgu parametreleri

Sorgu parametreleri · GET /v1/usage
NameTypeDescription
periodOptional
stringFaturalandırma döneminin başlangıcı, YYYY-MM-01; varsayılan olarak mevcut dönem.
limitOptional
integerMaksimum satır sayısı.

İstek

curl "https://api.toktokdata.live/v1/usage" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY"

Yanıt

200 OK
{  "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"    }  }}

Hatalar

  • 400 Geçersiz parametre veya gövde; sorunu code belirtir.
  • 401 Eksik veya bilinmeyen API anahtarı.
  • 403 Anahtar gereken kapsama sahip değil ya da plan bu özelliği içermiyor.
  • 429 İstek hızı aşıldı; Retry-After değerine uyun.
Bu sayfa işinize yaradı mı?