WebAPI¶
WebAPIは、https通信でSTRIXサーバーにJSONメッセージを送信することでSTRIXの処理を行わせる仕組みです。ゲームクライアントとSTRIXサーバーの間の通信ではなく、主に外部サーバーとSTRIXサーバーを連携させるために使用できます。
設定¶
Strix CloudでWebAPIを利用するには、アプリケーションダッシュボードのオプション画面で [WebAPI] チェックボックスをチェックしておきます。
エンドポイント¶
WebAPIでは、マスターサーバーやルームサーバーのそれぞれが独立したエンドポイントを持ちます。1つのサーバーインスタンスがマスターサーバーとルームサーバーを兼ねている場合でも、WebAPI用のエンドポイントは、マスターサーバー用とルームサーバー用に異なるURLが割り当たります。
サーバー側のエンドポイントURLは
<baseurl>/strix/handler
になります。ここに、<baseurl>はアプリケーションダッシュボードの詳細情報画面の後半にある[サーバーアドレス] で確認できます。例えば、<baseurl>が
https://rp.strixcloud.net/00112233-4455-6677-8899-AABBCCDDEEFF/master/
であれば、実際のエンドポイントURLは
https://rp.strixcloud.net/00112233-4455-6677-8899-AABBCCDDEEFF/master/strix/handler
になります。
WebAPIのエンドポイントURLにJSONメッセージをPOST送信すると、サーバーが処理を行い、結果がJSONレスポンスとして返ります。
APIキー¶
STRIXサーバーは、WebAPIの要求が適切な送信元から送られていることを確認するためにAPIキーを使用します。
Strix Cloudでは、APIキーは自動的に生成され、アプリケーションダッシュボードの詳細情報画面で確認できます。このAPIキーを、同じアプリケーションに属す全てのサーバーが使用します。STRIXサーバーと連携させたい外部サーバーに、このAPIキーを共有しておきます。
注釈
APIキーとはパスワードのようなものです。エンドポイントURLと、そのサーバーのAPIキーを知っていれば、第三者がサーバーにアクセスできてしまいます。
APIキーの情報が外部に流出しないよう、十分注意して管理してください。