RoomScope

อัปเดตล่าสุด

เริ่มต้นใช้งาน

สามขั้นตอน: สร้างคีย์ เรียก endpoint และอ่านที่มาของข้อมูล ทุกคำขอจะถูกคิดค่าใช้จ่ายจากกระเป๋าเครดิตของเวิร์กสเปซคุณ ซึ่งเป็นกระเป๋าเดียวกับที่แดชบอร์ดใช้

สิ่งที่ต้องมี

  • เวิร์กสเปซ RoomScope หากยังไม่มี เริ่มใช้ฟรี ได้เลย แพ็กเกจ Free สามารถอ่านบอร์ดที่แคชไว้ผ่าน API ได้
  • บทบาทที่จัดการคีย์ได้ (keys:manage) เจ้าของเวิร์กสเปซมีสิทธิ์นี้โดยค่าเริ่มต้น

1. สร้าง API key

ในแดชบอร์ด เปิด Settings → API keys → Create key ตั้งชื่อ แล้วเลือกสโคปที่คีย์ต้องใช้ ระบบจะแสดงคีย์ลับเพียง ครั้งเดียวให้เก็บไว้ในระบบจัดการความลับของคุณ หลังจากนั้นจะเห็นได้เฉพาะคำนำหน้าของคีย์เท่านั้น

2. ส่งคำขอแรก

ดึงบอร์ดอันดับรายวันทางการของเวียดนามสำหรับวันนี้ โดยตั้งค่า ROOMSCOPE_API_KEY ใน environment ของคุณก่อน

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 โดย provenance บอกว่าสัญญาณถูกบันทึกเมื่อใดและความครอบคลุมครบถ้วนเพียงใด ให้ถือว่าเป็นส่วนหนึ่งของผลลัพธ์ ไม่ใช่แค่ metadata

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) รายการ entries จะว่างเปล่า และ provenance.coverageStatus จะอธิบายเหตุผล รายการที่ถูกซ่อนชื่อ (masked: true) จะระบุแพ็กเกจที่ปลดล็อกการแสดงชื่อไว้ใน unmaskTier

ขั้นตอนถัดไป

หน้านี้มีประโยชน์หรือไม่