RoomScope

آخر تحديث

البدء

ثلاث خطوات: أنشئ مفتاحًا، واستدعِ نقطة نهاية، واقرأ مصدر البيانات. يُحتسب كل طلب من محفظة الرصيد في مساحة عملك، وهي المحفظة نفسها التي تستخدمها لوحة التحكم.

المتطلبات المسبقة

  • مساحة عمل على RoomScope. ابدأ مجانًا إن لم تكن لديك واحدة؛ إذ يمكن لباقة Free قراءة لوحات التصنيف المخزنة مؤقتًا عبر واجهة API.
  • دور يسمح بإدارة المفاتيح (keys:manage). يملك مالكو مساحات العمل هذا الدور افتراضيًا.

1. أنشئ مفتاح API

في لوحة التحكم افتح Settings → API keys → Create key، وامنح المفتاح اسمًا واختر النطاقات التي يحتاجها. يُعرض السر مرة واحدة فقط؛ فاحفظه في أداة إدارة الأسرار لديك. بعد ذلك لا تظهر إلا البادئة الخاصة بالمفتاح.

2. أرسل طلبك الأول

اجلب لوحة التصنيف اليومية الرسمية لفيتنام لهذا اليوم. اضبط أولًا ROOMSCOPE_API_KEY في بيئة التشغيل لديك.

curl "https://api.toktokdata.live/v1/rankings/official?board=daily&region=VN&period=current&limit=10" \  -H "Authorization: Bearer $ROOMSCOPE_API_KEY" \  -H "Accept: application/json"

3. اقرأ الاستجابة

تحتوي كل استجابة ناجحة على كائن data وكائن provenance. يخبرك مصدر البيانات بوقت رصد الإشارة وبمدى اكتمال التغطية؛ فتعامل معه كجزء من النتيجة، لا كبيانات وصفية.

200 OK
{  "data": {    "board": {      "publishable": true,      "periodKey": "2026-11-01",      "resetAt": "2026-11-02T00:00:00Z",      "coverage": { "completeBoards": 24, "expectedBoards": 24 },      "entries": [        {          "rank": 1,          "creatorUid": "7123456789012345678",          "uniqueId": "room.one",          "nickname": "Room One",          "score": 2410000,          "isLive": true,          "leagueClass": null,          "movement": "same",          "masked": false,          "unmaskTier": null        }      ]    }  },  "provenance": { "coverageStatus": "observed", "observedAt": "2026-11-01T09:58:12Z" }}

إذا لم تكن لوحة التصنيف قابلة للنشر بعد (publishable: false)، فستكون قائمة الإدخالات فارغة ويوضح provenance.coverageStatus السبب. أما الإدخالات ذات الأسماء المخفية (masked: true) فتحمل في unmaskTier الباقة التي تُظهرها.

الخطوات التالية

هل كانت هذه الصفحة مفيدة؟