外部アプリ連携(OAuth2 / API)

comilio ログインの組み込みや API でファンクラブ加入者を判定できる、開発者向けの連携機能の利用申請と設定

comilio には、クリエイターが自分のアプリやサイトと連携するための開発者向け機能があります。

  • comilio でログイン(OAuth2 / OpenID Connect): 自分のアプリに comilio アカウントでのログインを組み込めます。
  • REST API: ログインしたユーザーがファンクラブに加入しているかの判定、加入者一覧の取得、comilio PAY のチェックアウトセッションの作成などができます。

これらを組み合わせると、ファンクラブ限定コンテンツを提供する外部アプリなどを作成できます。

利用申請

現在はお試し運用中のため、利用には申請と審査が必要です(審査には最長 1 週間程度かかる場合があります)。

  1. サークル管理画面の「OAuth2クライアント一覧」を開く

    /studio/サークルID/oidc-apps を開くと「API利用申請」の案内とあなたのサークル ID が表示されます。

  2. 申請フォームから申請する

    「申請フォームへ」から申請フォームを開き、サークル ID と利用目的を送信します。

審査が完了すると、同じページでアプリを作成できるようになります。

アプリ(OAuth2 クライアント)を作成する

「OAuth2クライアントの作成」から次の項目を登録します。

項目内容
アプリアイコン500×500px 以上推奨
アプリの種類Web(ネイティブアプリは今後対応予定)
アプリ名1〜64 文字
説明文1,024 文字まで。ユーザーの同意画面に表示されます
Callback URI(Redirect URL)5 つまで
Web サイト URL必須
利用規約 URL / プライバシーポリシー URL任意
OAuth2 クライアントの作成画面

作成後、アプリの詳細画面から次の設定を行えます。

  • App Keys: API Token(REST API の Bearer トークン)、Client ID、Client Secret、Issuer(https://idp.comilio.app)の確認と再生成
  • Webhook 設定: comilio PAY の決済イベントを受け取る Webhook URL
  • 編集 / アプリを消去

ユーザーから見た動作

ユーザーがあなたのアプリで「comilio でログイン」すると、同意画面でアプリが参照する情報(ユーザー ID、表示名、Discord ID、メールアドレスのうち要求したもの)が表示されます。ユーザーは連携しているアプリからいつでも許可を取り消せます。

連携しているアプリ(外部サービスへのログイン)

API ドキュメント

エンドポイントの一覧と仕様は api.comilio.app/docs で公開しています。主なエンドポイントは次のとおりです。

  • サークル情報の取得
  • ファンクラブプランの一覧・取得
  • ファンクラブ加入者の一覧・加入判定
  • comilio PAY のチェックアウトセッションの作成・取得・キャンセル