RoomScope

Terakhir diperbarui

Memulai

Tiga langkah: buat key, panggil endpoint, baca asal datanya. Setiap permintaan ditagih dari dompet kredit workspace Anda, dompet yang sama dengan yang dipakai dashboard.

Prasyarat

  • Workspace RoomScope. Mulai gratis jika Anda belum punya; paket Free dapat membaca papan dari cache melalui API.
  • Peran yang boleh mengelola key (keys:manage). Pemilik workspace memilikinya secara default.

1. Buat API key

Di dashboard, buka Settings → API keys → Create key, beri nama, lalu pilih scope yang dibutuhkan. Secret hanya ditampilkan sekali; simpan di secret manager Anda. Setelah itu hanya prefix key yang terlihat.

2. Kirim permintaan pertama Anda

Ambil papan harian resmi Vietnam untuk hari ini. Atur ROOMSCOPE_API_KEY di environment Anda terlebih dahulu.

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. Baca respons

Setiap respons yang berhasil memiliki objek data dan objek provenance. Asal data memberi tahu kapan sinyal diamati dan seberapa lengkap cakupannya; perlakukan sebagai bagian dari hasil, bukan sekadar 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" }}

Jika papan belum dapat dipublikasikan (publishable: false), daftar entri akan kosong dan provenance.coverageStatus menjelaskan alasannya. Entri yang disamarkan (masked: true) mencantumkan paket yang membukanya di unmaskTier.

Langkah berikutnya

Apakah halaman ini membantu?