Partner OAuth 連携

Beta。 OAuth モードは段階的に公開中です。お問い合わせいただければアプリを登録します。

ofox を自社プロダクトに組み込む予定がある場合、ユーザーは OAuth ボタンから ofox に移動してログインと認可を行い、あなたのアプリに戻ることができます。この方法で登録した新規ユーザーは自動的にあなたの partner チャネルに計上されます —— 紹介リンク経由の登録とまったく同じ扱いです。

導入手順

アプリが開発中でも申請できます。プロダクトの完成を待つ必要はありません。 OAuth 連携は現在 Beta 段階で、登録情報はチームが確認します。

まだパートナープログラムに参加していない場合は、先に Partner ページから申請してください。申請済み・有効化済みのパートナーは再申請不要です。
下記の登録情報を hi@ofox.ai に送るか、既存のサポートメールに返信してください。
アプリ情報、コールバック URL、必要な権限を確認したうえで、当社が OAuth アプリを登録して紹介チャネルに紐付け、接続用の設定をお送りします。
プロダクトに OAuth 2.1 を組み込み、認可、アプリへの復帰、モデル呼び出しまでの流れを確認してください。

チャネルの帰属に紹介パラメーターを追加する必要はありません。登録時に当社で設定します。OAuth 自体のコールバック URL、権限、認可フローは、お送りする設定に沿って実装してください。

アプリ登録に必要な情報

項目	記載してほしい内容
アプリ名と用途	仮の名前でも構いません。主な機能、対象ユーザー、ofox のモデルサービスをどう使うかを記載してください
アプリの形態	Web、デスクトップクライアント、モバイルアプリ、ブラウザ拡張、CLI ツールのいずれか。独自のバックエンドがあるか
OAuth コールバック URL（Redirect URI）	認可後にアプリへ戻る完全な URL。テスト環境と本番環境を分けて記載してください。登録前に URL を確定する必要がありますが、未定の場合はまず技術構成を説明してください
Partner 情報	パートナープログラムに申請したメールアドレスと、紹介リンクまたは紹介コード。同じメールで提供済みの内容は再送不要です
必要な機能	モデル呼び出し、残高や利用量の表示、組織情報の読み取り、ログイン維持が必要か。権限を自分で選ぶ必要はなく、要件をそのまま記載してください
プロダクトのリンクとロゴ（後日でも可）	公式サイト、リポジトリ、デモページ、スクリーンショットがあれば併せてお送りください。未公開の場合は簡単な紹介で構いません。ロゴは後から追加できます

コールバック URL は登録値と完全に一致している必要があり、ワイルドカードは使えません。プロトコル、ドメイン、ポート、パス、末尾の / まで一致させてください。Web の本番環境では HTTPS を推奨します。デスクトップ、モバイル、ローカル開発の場合は、登録時にコールバックの方式を説明してください。

連携の相談のために、完全なソースコードや完成したプロダクトを先に提出する必要はありません。申請メールにパスワード、API Key、Client Secret、Access Token を含めないでください。

以下のテンプレートをコピーしてお使いください。未定の項目は「未定」と記載してください。


アプリ名：
用途 / 対象ユーザー：
アプリの形態 / バックエンドの有無：
テスト環境のコールバック URL：
本番環境のコールバック URL：
Partner 申請メールアドレス：
Partner 紹介リンクまたは紹介コード：
必要な機能：
プロダクトのリンク / 紹介（あれば）：
ロゴ（あれば）：

導入前に確認すること

クライアントの種類：バックエンドを持ち秘密情報を安全に保管できるアプリと、ブラウザ・デスクトップ・モバイル上で直接動くアプリでは、接続設定が異なります。実際の構成を説明してください。Client Secret をフロントエンドのコードやユーザーに配布するインストーラーに含めないでください。
権限の範囲：プロダクトで実際に必要な権限だけを申請してください。モデル呼び出しには llm.invoke が必要です。その他の機能は要件に応じて確認し、付与される権限は実際の認可結果に従います。
接続テスト：登録後は提供された設定に沿って接続してください。問題があれば、操作手順、機密情報を除いたエラー内容、発生時刻をお知らせください。トークンや秘密鍵は送らないでください。

何が計上されるか

新規登録のみ。 ofox アカウントを持たないユーザーがあなたの OAuth ボタンを押すと、ofox のログインページに遷移し、登録フローに切り替えて登録を完了します —— その瞬間にチャネルへの紐付けが作成されます。以降、そのユーザーのチャージと利用は通常の partner 報酬精算の対象となります。

すでに ofox アカウントをお持ちのユーザーの帰属は変更されません。 あなたのアプリを認可しても変わりません —— そのユーザーがどの partner にも紐付いていない場合でも同様です。他の partner に紐付いているユーザーにも、まったく紐付きのないユーザーにも当てはまります。

これは意図的な設計です。紹介による紐付けはアカウントに対して生涯かつ排他的です。付け替えを許すと、ある partner が別の partner の獲得したユーザーを奪えてしまいます。

初回呼び出し時の scope

サインアップ直後に受け取る access token には、まだ llm.invoke が含まれていない場合があります。

llm.invoke はメールアドレスが確認済みのユーザーにのみ付与されます。サインアップ完了時点で確認済みかどうかは、ユーザーがどの方法で登録したかによって変わります。

登録方法	完了時にメール確認済みか	最初の token に `llm.invoke` があるか
パスワードレスリンク	はい — リンクを開くこと自体が確認	付与される
メール + パスワード	いいえ	確認まで除外される

scope が除外されても token リクエスト自体は成功します。レスポンスの scope フィールドが実際に付与された集合です（RFC 6749 §3.3）。要求した通りに得られたと仮定せず、必ずこのフィールドを読んでください。 llm.invoke なしで LLM API を呼ぶと 403 insufficient_scope が返ります。

ユーザーがメール確認を完了したあとに token を取り直す（またはリフレッシュする）と、llm.invoke が含まれます。

報酬

帰属したユーザーは、実際の API 利用量に基づく標準の段階的 partner 報酬（最大 9%）で精算されます。$50 から出金可能、月次精算です。最新の条件は Partner ページをご覧ください。