RoomScope

Son güncelleme

Başlarken

Üç adım: bir anahtar oluşturun, bir endpoint’i çağırın, kaynak bilgisini okuyun. Her istek, çalışma alanınızın kredi cüzdanından ölçülür; panelin kullandığı cüzdanın ta kendisi.

Ön koşullar

  • Bir RoomScope çalışma alanı. Henüz yoksa ücretsiz başlayın; Free planı, önbellekteki sıralamaları API üzerinden okuyabilir.
  • Anahtarları yönetebilen bir rol (keys:manage). Çalışma alanı sahipleri bu yetkiye varsayılan olarak sahiptir.

1. Bir API anahtarı oluşturun

Panelde Ayarlar → API anahtarları → Anahtar oluştur yolunu açın, anahtara bir ad verin ve ihtiyaç duyduğu kapsamları seçin. Gizli anahtar yalnızca bir kez gösterilir; onu gizli bilgi yöneticinizde saklayın. Sonrasında yalnızca anahtarın öneki görünür.

2. İlk isteğinizi gönderin

Vietnam’ın bugünkü resmî günlük sıralamasını çekin. Önce ortamınızda ROOMSCOPE_API_KEY değişkenini tanımlayın.

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. Yanıtı okuyun

Her başarılı yanıtta bir data nesnesi ve bir provenance nesnesi bulunur. Kaynak bilgisi, sinyalin ne zaman gözlemlendiğini ve kapsamın ne kadar eksiksiz olduğunu söyler; onu meta veri olarak değil, sonucun bir parçası olarak ele alın.

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" }}

Sıralama henüz yayımlanabilir değilse (publishable: false), giriş listesi boş olur ve nedenini provenance.coverageStatus açıklar. İsmi gizlenmiş girişler (masked: true), isimlerini açan planı unmaskTier alanında taşır.

Sonraki adımlar

  • Kimlik doğrulama: kapsamlar, anahtar yenileme ve 401 ya da 403’ün ne anlama geldiği.
  • Hatalar: hata zarfı ve ne zaman yeniden denenmesi gerektiği.
  • Sıralamalar referansı: GET /v1/rankings/official endpoint’inin tüm parametreleri.
Bu sayfa işinize yaradı mı?