アプリケーション開発
mixi2 Developer Platform でのアプリケーション設定、Webhook URL の構成、デプロイ方法を解説します。
このガイドでは、アプリケーション設定から、デプロイ、テストまでの流れを解説します。
前提条件
イベント受信方式
アプリケーションはイベントを受信して処理を行います。2 つのイベント受信方式から選択できます。
| 方式 | 推奨シーン |
|---|---|
| gRPC ストリーム | ローカル開発、プロトタイピング |
| HTTP Webhook | 本番環境、サーバーレス環境 |
各方式の詳細は Webhook、gRPC ストリーム をそれぞれ参照してください。
Webhook の設定
Webhook 方式を使用する場合、mixi2 Developer Platform で URL を登録し、検証を完了させる必要があります。
設定手順
- mixi2 Developer Platform の管理画面でアプリケーションの「Webhook」を開きます
- Webhook URL を登録します
- 「接続確認を実行」を押します
URL の要件、署名検証の仕様、検証の仕組みの詳細は Webhook でイベントを受信する を参照してください。
Webhook の状態
| 状態 | 説明 |
|---|---|
| 無効 | 初期状態、または無効にした状態 |
| 確認中 | 「接続確認を実行」を押した後の接続確認中 |
| 確認失敗 | 接続確認に失敗した状態 |
| 有効 | 接続確認が完了し、イベントを受信できる状態 |
「有効」から「無効にする」にするとステータスは「無効」に戻ります。エンドポイントを再設定した場合も「無効」に戻るため、再度接続確認を実行する必要があります。
環境変数
アプリケーションサーバーの動作には、認証情報や接続先情報を環境変数として設定する必要があります。取得方法と設定手順はクイックスタートを参照してください。
デプロイ
Webhook 方式を使用する場合、HTTPS に対応した URL でリクエストを受信できる環境が必要です。デプロイの詳細は Webhook でイベントを受信する - デプロイ を参照してください。
エラーハンドリング
API 呼び出し時にエラーが発生した場合は、エラーの種類に応じて適切に対処してください。
| エラー種別 | 対処法 |
|---|---|
| 認証エラー | トークンを再取得してリトライ（SDK は自動で対応） |
| レート制限超過 | retry-after ヘッダーに従って待機後リトライ |
| サーバーエラー | 指数バックオフでリトライ（最大 3 回程度） |
| クライアントエラー (4xx) | リトライせずログ出力、リクエスト内容を確認 |
レート制限の詳細（制限値、レスポンスヘッダー、エラーレスポンス）はレート制限を参照してください。
テスト方法
開発中のテストは以下の手順で行います。
- gRPC ストリーム方式でアプリケーションを起動
- mixi2 アプリから実際にメンション・DM を送信
- ログでイベント受信と処理結果を確認
テスト用のサンドボックス環境やイベントシミュレート機能は現在提供されていません。
開発リソース
アプリケーション開発に必要なリソースは GitHub で公開しています。詳細は GitHub リポジトリを参照してください。
| リポジトリ | 説明 |
|---|---|
| mixi2-api | API 定義（Protocol Buffers） |
| mixi2-application-sdk-go | Go 向け公式 SDK |
| mixi2-application-sample-go | サンプルアプリケーション |
次のステップ
- Webhook でイベントを受信する - Webhook 方式の実装・署名検証・デプロイ
- gRPC ストリームでイベントを受信する - gRPC 方式の実装・再接続
- イベント - イベントの種類と構造
- SDK ガイド - SDK の基本（認証、イベントハンドラ）
- API の使い方 - ポストの作成、DM の送信、メディアのアップロード
- API リファレンス - API の完全な仕様
- レート制限 - API のレート制限