RevenueUIドキュメント

RevenueUI ドキュメント

読み取りAPI・OAuth・MCP

自動処理や外部アプリに、1つのWebサイトへ限定した読み取り専用アクセスを付与します。

サイト読み取りキー

Webサイト設定 → API & MCPでキーを作成します。平文キーが表示されるのは一度だけで、RevenueUIにはSHA-256ハッシュだけが保存されます。キーは1サイトに限定され、Analytics、Live、Web Vitalsの読み取り権限を個別に設定できます。

Authorization: Bearer rui_read_...として次のエンドポイントへ送信します。

  • GET /api/v1/read/analytics
  • GET /api/v1/read/realtime
  • GET /api/v1/read/web-vitals

MCP

同じBearerキーでPOST /api/mcpをStreamable HTTP JSON-RPCエンドポイントとして利用できます。get_analytics、get_realtime、get_web_vitalsツールを公開します。書き込み権限や生の識別子へのアクセスは付与されません。

PKCEを使うOAuth 2.0

API & MCP設定でアプリ名と正確なHTTPSリダイレクトURIを登録します。公開クライアントはS256 PKCE付きAuthorization Codeを使用し、クライアントシークレットは発行されません。認可コードは10分で期限切れとなる一回限りのコードで、アクセストークンは30日で期限切れになります。

認可にはフロントエンドの/oauth/authorize、コード交換にはPOST /api/oauth/tokenを使います。OAuthクライアントを削除すると、そのクライアントへ発行したキーも失効します。