อัปเดตล่าสุด
การยืนยันตัวตน
ทุกคำขอต้องแนบ API key ของเวิร์กสเปซในรูปแบบ Bearer token คีย์กำหนดสโคปได้ เพิกถอนได้ และผูกกับกระเป๋าเครดิตของเวิร์กสเปซเดียว
Bearer key
ส่งคีย์ใน header Authorization ในรูปแบบ Bearer <key> คีย์มีหน้าตาแบบ ttk_live_<id>_<secret> และแดชบอร์ดจะแสดงรายการคีย์ด้วยคำนำหน้า ttk_live_<id> สร้างคีย์ได้ที่ Settings → API keys โดยระบบจะแสดงคีย์เต็มเพียงครั้งเดียว คีย์จะทำงานในนามเจ้าของเวิร์กสเปซ ภายในขอบเขตสโคปของคีย์นั้น
curl "https://api.toktokdata.live/v1/rankings/regions" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY"สโคป
คีย์เรียกได้เฉพาะ endpoint ที่อยู่ในสโคปของคีย์เท่านั้น เลือกชุดสโคปที่เล็กที่สุดที่ทำงานได้ และคุณสร้างคีย์ที่สองเพิ่มได้เสมอ คำขอที่อยู่นอกสโคปของคีย์ และเส้นทางที่ใช้ได้เฉพาะในแดชบอร์ด (รายการติดตาม ห้อง เวิร์กสเปซ การเรียกเก็บเงิน) จะได้รับ 403 พร้อม code insufficient_scope ส่วนแพ็กเกจที่ไม่มีโมดูลนั้นจะได้รับ module_not_entitled
| สโคป | สิทธิ์ที่ได้รับ |
|---|---|
live:read | เซสชัน LIVE ข้อมูลเซสชันรายตัว ประสิทธิภาพของครีเอเตอร์ และการรีเฟรชสถานะไลฟ์ ต้องมีโมดูล LIVE |
rank:read | บอร์ดอันดับทางการ ภูมิภาค และประวัติบอร์ด ต้องมีโมดูล LIVE |
shop:read | จำเป็นเพิ่มเติมสำหรับบอร์ดช้อปปิ้ง (board ที่ขึ้นต้นด้วย shopping) |
creator:read | การค้นหาครีเอเตอร์ โปรไฟล์ การวิเคราะห์ การเปลี่ยนแปลง รายการที่กำลังติดตาม ผู้ติดตาม และข้อมูลเชิงลึก ต้องมีโมดูลค้นหา |
content:read | วิดีโอ ความคิดเห็นของวิดีโอ และวิดีโอของครีเอเตอร์ ต้องมีโมดูลค้นหา |
trend:read | เทรนด์ระดับภูมิภาค ต้องมีโมดูลค้นหา |
export | สร้าง แสดงรายการ และดาวน์โหลดไฟล์ส่งออก |
webhook:manage | กฎการแจ้งเตือนในทุกช่องทาง และการทดสอบกฎ ต้องมีโมดูล LIVE |
keys:manage | แสดงรายการ สร้าง และเพิกถอน API key อ่านสิทธิ์การใช้งานและปริมาณการใช้ |
live:stream · gifter:read | สงวนไว้สำหรับ endpoint ที่กำลังจะมา ขณะนี้ยังไม่ให้สิทธิ์ใด ๆ |
การหมุนเวียนคีย์
สร้างคีย์ใหม่ที่จะใช้แทนก่อน นำไปใช้งาน แล้วจึงเพิกถอนคีย์เก่าจากหน้าจอเดียวกัน การเพิกถอนมีผลทันที คำขอที่กำลังดำเนินอยู่จะทำงานจนเสร็จ ส่วนคำขอใหม่จะล้มเหลวด้วย 401
คุณยังสร้างคีย์พร้อมวันที่ expiresAt ได้ด้วย หลังจากวันที่นั้นคีย์จะตอบกลับเป็น 401
ข้อผิดพลาด
| สถานะ | Code | ความหมาย |
|---|---|---|
| 401 | unauthorized | ไม่มีคีย์ คีย์ผิดรูปแบบ ถูกเพิกถอน หรือหมดอายุ หรือเวิร์กสเปซไม่ได้ใช้งานอยู่ |
| 403 | insufficient_scope | คีย์ใช้ได้แต่ไม่มีสโคปที่ต้องการ หรือเส้นทางนั้นใช้ได้เฉพาะในแดชบอร์ด |
| 403 | module_not_entitled | แพ็กเกจของเวิร์กสเปซไม่รวมโมดูล LIVE หรือโมดูลค้นหา |
| 402 | credit_cap_exceeded | เครดิตของเดือนนี้ใช้หมดแล้ว ดู เครดิต และ ข้อผิดพลาด |