OpenFRESHについて(API機能提供)

OpenFRESHは生放送動画配信プラットフォーム FRESH LIVEを便利に利用するための開発者向けプロジェクトです。

OpenFRESHとは

OpenFRESHはFRESH LIVEの機能をAPIとして開放することで、より高度かつ便利にFRESH LIVEを利用して頂いたり、独自のツール開発を促進していくためのプロジェクトです。

サードパーティツールに対する考え方

既にコメント読み上げツールのような非公式のサードパーティツールが存在しております。

FRESH LIVEは技術的にも開かれたプラットフォームを目指しています。そのため、公共・公益を害する性質のものでなければ基本的にこのようなサードパーティツールの存在は肯定しております。そして、今まで以上に開発・利用が活発になっていくべきであるというのがFRESH LIVEとしての考え方です。

API仕様

現在、OpenFRESH APIβ公開中です。コメント取得・投稿のAPIのみを提供しております。コメント投稿には認証(現在は配信主アカウントをお持ちのユーザー様のみ)が必要ですが、コメント取得には認証は必要ありません。

APIドキュメントはGitHub Pageshttps://openfresh.github.io/)に公開しておりますのでご覧ください。

OpenFRESHプロジェクトとしては引き続き公開APIの拡充等を鋭意行ってまいります。

留意事項

アクセストークンの扱い

アクセストークンはJWT(Json Web Token)形式で発行され、一度発行されたアクセストークンは1年間有効です。JWTは改竄に強くセキュアですが、生成されたアクセストークンは第3者に不正利用されないように各々のユーザーで保管しておく必要があります。

RATELIMIT

OpenFRESH APIにRateLimit(時間単位でのAPIコール数制限)が設定されています。現在は1ホストまたは1ユーザーあたり60回/1分の制限を設けており、それを越えるAPIの利用をした場合はHTTP 429 Too Many Requestsを返します。 RateLimitに達した場合は少し待ってからAPIリクエストをし、直近1分間のリクエスト数が60回を超えないような制御をする必要があります。

この記事は役に立ちましたか?

Related Articles