API と SDK で開発する
7:50 ウォークスルー
動画のナレーションは英語です。
Toktik Developer API は従量制の REST API で、公式 SDK として JavaScript/TypeScript 向けの @toktikhq/sdk-js と、Python 向けの toktik があります。クイックスタート、認証、クレジットから始めて、すぐに使える cURL、JavaScript、Python の例をコピーしてください。
このガイドで学べること
- キーを発行して、最初の認証済みリクエストを送る
- スコープ、レート制限、クレジットのしくみを理解する
- JavaScript と Python の SDK を使う
- ドキュメントを読む:クイックスタート、エンドポイント、スコープ
しくみ
Settings でキーを作成する
アプリで Settings を開き、Developer keys で、rank:read のように必要なスコープだけを持つキーを作成します。シークレットは ttk_live_ で始まり、一度だけ表示されるので、環境変数に保管してください。キーが使えるのはデータのルートだけで、キーの作成はサインイン状態での操作に限られます。
最初のリクエストを送る
ttk_live_ のシークレットを使って、キーを Authorization: Bearer として送ります。ドキュメントのクイックスタートでは、api.toktikhq.com/v1/rankings/official の公式ランキングボードを、board=hourly と region=VN で呼び出します。403 は、そのルートに必要なスコープがキーにないことを意味します。
制限とクレジットの範囲内で使う
各キーにはプランに応じた 1 秒あたりのリクエスト上限があり、Free の 1 から Agency の 150 までです。上限を超えると 429 が返るので、Retry-After を待って再試行してください。クレジットが尽きると 402 が返り、再試行しても解決しません。GET /v1/usage で使用状況を確認できます。
公式 SDK を追加する
JavaScript と TypeScript には npm i @toktikhq/sdk-js を、Python には pip install toktik をインストールします。どちらも同じキーと同じクレジットウォレットで、同じ v1 REST API を呼び出します。Docs ページの Quickstart と API Reference に、すべてのエンドポイント、パラメーター、スコープが載っています。
よくある質問
Toktik の API の料金はいくらですか?
API 専用の料金表はありません。Web アプリと API は、同じプランの同じクレジットウォレットを消費します。Toktik のストアから提供される読み取りは 1 クレジット、エクスポートは 2,500 クレジット、オンデマンドの収集呼び出しはそれより多く消費されます。
Toktik API のレート制限はどうなっていますか?
キーごと、1 秒あたりで、Free は 1、Starter は 5、Pro は 20、Scale は 60、Agency は 150 です。1 日あたりの上限もあり、Free の 5,000 リクエストから Agency の 1,200,000 まであります。上限を超えると 429 が返り、ヘッダーにウィンドウの状態が示されます。
Toktik には公式 SDK がありますか?
はい。@toktikhq/sdk-js は JavaScript と TypeScript に、toktik パッケージは Python に対応しています。どちらも同じキーで同じ v1 REST API を呼び出します。
Toktik API の 402 と 403 の違いは何ですか?
402 は、ワークスペースのクレジットが尽きたことを意味するので、再試行ではなくチャージしてください。403 は、キーは有効でも必要なスコープがないことを意味するので、スコープを付与するか、サインイン済みのセッションを使ってください。429 はレート制限で、間隔を空けてから再試行して問題ありません。