Sora Cloud API

概要

Sora Cloud では組織とプロジェクト向けの API を提供しています。

利用方法

API ベース URL:

https://api.sora-cloud.shiguredo.app

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

重要

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

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

Bearer トークンにはプロジェクトで作成した API キーを指定してください。

組織 API

組織 API を利用するにはプロジェクトでの API キーのパーミッションをプロジェクトと組織の両方を指定してください。

ステータス API

組織 ステータス API

組織の現在のステータスを取得する API です。

トラフィック API

組織 トラフィック API

組織のトラフィック情報を取得する API です。

セッション API

組織 セッション API

組織のセッション情報を取得する API です。

ログ API

組織 ログ API

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

録画ログ API

組織 録画ログ API

組織の録画ログ情報を取得する API です。

プロジェクト API

無効 (disabled) に設定されているプロジェクトでは利用できません。

アクセストークン API

プロジェクトアクセストークン API

アクセストークンを生成、管理する API です。

トラフィック API

プロジェクトトラフィック API

プロジェクトのトラフィック情報を取得する API です。

セッション API

プロジェクトセッション API

プロジェクトのセッション情報を取得する API です。

ログ API

プロジェクトログ API

プロジェクトのログ情報を取得する API です。

録画ログ API

プロジェクト 録画ログ API

プロジェクトの録画ログ情報を取得する API です。

シーケンス図

sequenceDiagram participant cloud as Sora Cloud participant app as アプリケーションサーバー app->>+cloud: 今月の合計コネクション数 API<br>/orgs/get-total-connections-this-month cloud-->>-app: 200 OK
© Copyright 2024, Shiguredo Inc. Created using Sphinx 8.0.2