Skip to Content
ドキュメントPartner 連携

Partner OAuth 連携

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

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

導入手順

  1. お問い合わせいただき、アプリを登録します。
  2. 当社側で OAuth アプリケーションを作成し、あなたの紹介チャネルに紐付けます。
  3. 標準的な OAuth 2.1 フローで認可ボタンをプロダクトに組み込みます。

標準の OAuth フロー以外に、あなた側で必要な設定はありません —— 追加パラメータも、URL 形式の取り決めも、SDK も不要です。チャネルの紐付けは当社側のサーバーで設定します。

何が計上されるか

新規登録のみ。 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 ページ  をご覧ください。

Last updated on