API

概要

Tobi API を使用すると開発者はアクセストークンの作成や利用した同時接続数や帯域の確認、 ウェブフックの設定などの機能や、Sora API を利用する事が可能です。

利用方法

API ベース URL:

https://api.tobi.shiguredo.app

HTTP API を実行する例では httpie を利用しています。

重要

すべての API で POST を利用します。

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/team/get-total-connections-this-month \
    -vvv

Bearer トークンには利用開始時にお送りしたメールにて記載されている API キーを指定してください。

create-access-token

API URL:

https://api.tobi.shiguredo.app/create-access-token

認証に利用する JWT アクセストークンを作成します。 Tobi 固有のクレームと JWT 登録クレームが指定できます。

すべての指定はオプションです。

channel_id

オプション

:

string

Sora のチャネル ID を指定します。

role

オプション

:

string

Sora のロール (sendrecv / sendonly / recvonly) を指定します。

sora_auth_webhook_url

:

string

  • Sora の認証ウェブフッククエストの送り先を URL で指定します

  • オプション

sora_session_webhook_url

:

string

  • Sora の認証ウェブフッククエストの送り先を URL で指定します

  • オプション

sora_event_webhook_url

:

string

  • オプション

tobi_webhook_url

オプション

:

string

Tobi のウェブフッククエストの送り先を URL で指定します。

max_channel_connections

オプション

:

integer

範囲:

0-100

チームの最大同時接続数を指定します。この設定は接続単位で影響します。

例えばこの設定が 1 のトークンを利用した接続はチャネルにに 1 接続以上存在する場合は接続が出来なくなります。

not_before

オプション

:

RFC 3339

URL:

JWT nbf

JWT が有効になる日時を指定します。数値ではなく RFC 3339 フォーマットで指定してください。

expiration_time

オプション

:

RFC 3339

URL:

JWT exp

JWT の有効期限を指定します。数値ではなく RFC 3339 フォーマットで指定してください。

issuer

オプション

:

string

URL:

JWT iss

issued_at

オプション

:

RFC 3339

URL:

JWT iat

jwt_id

オプション

:

string

URL:

JWT jti

実行例

$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/create-access-token \
    channel_id=[email protected]#9999 \
    -vvv
$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/create-access-token \
    channel_id=[email protected]#9999 \
    not_before='2022-10-20T10:00:00+09:00' \
    expiration_time='2023-10-27T10:00:00+09:00' \
    -vvv
$ https -A bearer -a <API-KEY> \
    POST api.tobi.shiguredo.app/create-access-token \
    channel_id=[email protected]#9999 \
    max_channel_connections:=10 \
    sora_auth_webhook_url=https://example.com/tobi/auth \
    sora_event_webhook_url=https://example.com/tobi/event \
    -vvv

ステータス API

ステータス API

現在の利用合計系を取得する API です。

トラフィック API

トラフィック API

帯域と同時接続数を月や日単位で取得する API です。

ライブ API

ライブ API

現在の同時接続数やセッションの一覧を取得する API です。

ログ API

ログ API

ログ情報を取得する API です。

開発 API

開発 API

API や ウェブフックに関する設定や情報を取得する API です。

録画 API

注意

これはまだ開発中です、正式版で利用可能になります

録画 API

録画ファイル保存のオブジェクトストレージの設定や録画ファイルの情報を取得する API です。

設定 API

設定 API

アカウント一覧や現在の設定を取得する API です。

課金 API

課金 API

課金に関する情報を取得する API です。

Sora API

Sora API

Sora の HTTP API を実行する API です。

© Copyright 2022, Shiguredo Inc. Created using Sphinx 5.0.0