WebSocket API
わんコメ搭載のWebSocket APIについて
概要
わんコメではWebSocket APIを搭載しています
WebSocket APIではHTTP APIと異なりイベントを常時購読することでリアルタイムに最新の情報や変更情報を取得することができます
利用上の注意
caution
APIドキュメントは一部不完全です
Discrodサーバーの開発者専用チャンネルにて追加や最新情報をやり取りしています
開発者の方はぜひDiscordに参加して開発者であることをお知らせください
利用規約を再度ご確認ください
連携アプリケーション・サービスにもわんコメの利用規約が適用されます
クレジットの表記について
HTTP APIを利用したアプリケーション・サービスを使用する際にも無料利用の場合はクレジット表示が必要となります
アプリケーションを配布する際はクレジット表記に関する注釈を必ず記入してください
外部IPやドメインからの参照について
わんコメのAPIは安全上の理由からローカルIP以外でのアクセスに制限があります
外部IPやドメインからAPIへアクセスするためには「設定 > APIタブ」(設定ページ)にてアクセス許可するホスト名の登録が必要です
使い方
下記URLのWebSocket APIに接続します
ws://127.0.0.1:11180/sub?p=comments,config
パラメータ
name | required | |
---|---|---|
p | 〇 | 要求するデータタイプを,(カンマ)区切りで指定 未指定の場合データ取得できなくなります(v8.0以降) |
基本構造
購読した際のデータは基本的に次のようなJSON構造で返却されます
{
"type": "イベント名",
"data": { /*各種イベントのデータ*/ }
}
必要なデータの種類をtypeでswitchするなどして使用してください