クイックスタート

最初のアプリケーションを作成して、mixi2 Developer Platform での開発を始めましょう。

このガイドでは、mixi2 Developer Platform でアプリケーション（Bot）を作成し、イベントを受信して応答する基本的な流れを説明します。

前提条件

mixi2 Developer Platform にログインし、「新規アプリケーション」をクリックします。

mixi2 Developer Platform ホーム画面

以下の情報を入力してアプリケーションを作成します。

mixi2 Developer Platform アプリケーション作成画面

項目	説明
ID	mixi2 上で表示される ID です。ユーザー全体でユニークである必要があり、後から変更できません
表示名	アプリケーションの表示名です。後から変更できます

アプリケーションを作成すると、mixi2 上に指定した ID のアカウントが生成されます。mixi2 アプリで @ID を検索すると、アカウントが作成されていることが確認できます。

アプリケーションを作成すると、アプリケーション詳細画面に遷移します。

mixi2 Developer Platform アプリケーション詳細画面

サイドバーで「認証情報」を選択し、 Client Secret を生成します。

mixi2 Developer Platform アプリケーション認証情報画面

以下の情報が、後の手順で必要になります。

項目	説明
Client ID	OAuth 2.0 認証に使用するクライアント ID
Client Secret	OAuth 2.0 認証に使用するシークレット。再発行可能です

項目	説明
Token URL	アクセストークン取得用のエンドポイント URL
Stream Address	gRPC ストリーミング接続用のサーバーアドレス

Client Secret は秘密情報です。ソースコードにハードコーディングしたり、ログ出力したり、リポジトリにコミットしないでください。

アプリケーションサーバーのサンプルコードをセットアップします。

git clone https://github.com/mixigroup/mixi2-application-sample-go.git
cd mixi2-application-sample-go

このクイックスタートではサンプルコードリポジトリを使用しますが、SDK や API 定義など他の公開リポジトリもあります。詳しくは GitHub リポジトリを参照してください。

リポジトリ内の .env.example を .env にコピーし、Step 2 で生成した認証情報を設定します。

cp .env.example .env

.env ファイルを編集し、以下の環境変数を設定してください。

変数名	説明
`CLIENT_ID`	mixi2 Developer Platform で発行した OAuth2 クライアント ID
`CLIENT_SECRET`	mixi2 Developer Platform で発行した OAuth2 クライアントシークレット
`TOKEN_URL`	mixi2 Developer Platform で確認したトークンエンドポイント URL
`STREAM_ADDRESS`	mixi2 Developer Platform で確認した Stream サーバーアドレス

サンプルコードの詳細はSDK ガイドを参照してください。

アプリケーションサーバーと mixi2 のサーバーを接続する方法は、gRPC ストリーム接続と Webhook URL 登録の 2 種類があります。

ローカル環境から検証する場合は、外部からアクセス可能な URL が不要な gRPC ストリーム接続が便利です。以下のコマンドでアプリケーションサーバーを起動します。

source .env
go run cmd/stream/main.go

起動すると、mixi2 のサーバーに gRPC ストリーム接続を確立し、イベントの待ち受けを開始します。

アプリケーションサーバーが正しく動作しているか確認します。

mixi2 アプリで、Step 1 で作成したアプリケーションに DM を送信してください。ターミナルにイベント受信のログが表示され、送信した内容と同じメッセージが返ってくれば成功です。