Skip to Content
快速開始Partner 接入

Partner OAuth 接入

Beta。 OAuth 模式正在灰度開放,請聯絡我們登記你的應用。

如果你計畫把 ofox 整合進自己的產品,使用者可以點擊 OAuth 按鈕前往 ofox 完成登入與授權,再返回你的應用。透過這種方式註冊的新使用者會自動計入你的 partner 渠道 —— 與他們透過你的推廣連結註冊完全等效。

如何接入

應用仍在開發中也可以申請,不需要等產品全部完成。 OAuth 接入目前處於 Beta 階段,登記資訊需由團隊確認。

  1. 如果尚未加入合作夥伴計畫,請先在 Partner 頁面 申請;已申請或已啟用的夥伴無需重複申請。
  2. 將下方登記資訊寄至 hi@ofox.ai,或直接回覆既有的支援郵件。
  3. 我們確認應用資訊、回呼位址與所需權限後,為你登記 OAuth 應用並綁定推廣渠道,提供對應的接入設定。
  4. 在你的產品中完成 OAuth 2.1 接入,並驗證授權、返回應用及模型呼叫流程。

渠道歸因不需要額外附加推廣參數,由我們在登記時設定。OAuth 本身的回呼位址、權限與授權流程仍需依接入設定實作。

登記應用需要提供什麼

資訊需要說明的內容
應用名稱與用途暫定名稱也可以;說明主要功能、面向的使用者,以及如何使用 ofox 模型服務
應用形態網頁、桌面用戶端、手機應用、瀏覽器擴充功能或命令列工具;是否有自己的後端服務
OAuth 回呼位址(Redirect URI)授權後返回應用的完整位址;測試與正式環境請分別列出。實際登記前需確認位址,尚未確定可先說明技術方案
Partner 資訊申請合作夥伴計畫使用的電子郵件,以及推廣連結或推廣碼;已在同一封郵件中提供的內容無需重複提交
所需功能是否需要呼叫模型、顯示餘額或用量、讀取組織資訊、保持登入;直接描述需求即可,無需自行選擇所有權限
產品連結與 Logo(可後補)有官網、專案儲存庫、示範頁面或截圖可一併提供;產品尚未上線可先寫簡單介紹,Logo 可後續補充

回呼位址需要與登記值完全一致,不支援萬用字元;協定、網域、連接埠、路徑以及結尾的 / 都需要保持一致。網頁正式環境建議使用 HTTPS。桌面、手機或本機開發情境,請在登記時說明回呼方式。

不需要為了發起接入諮詢先提交完整原始碼或開發完成的產品。請勿在申請郵件中寄送密碼、API Key、Client Secret 或 Access Token。

可複製以下範本,尚未確定的項目標註「待確認」:

應用名稱: 應用用途 / 面向使用者: 應用形態 / 是否有後端: 測試環境回呼位址: 正式環境回呼位址: Partner 申請電子郵件: Partner 推廣連結或推廣碼: 需要的功能: 產品連結 / 介紹(如有): Logo(如有):

接入前需要確認

  • 用戶端類型:有後端並能安全保管密鑰的應用,與直接在瀏覽器、桌面或手機中執行的應用,接入設定不同。請說明實際架構;不要把 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 就會包含在內。

返佣

被歸因的使用者按標準分層返佣結算(最高 9%),依據實際 API 用量計算。滿 $50 起提,按月結算。當前條款見 Partner 頁面 。

最後更新於