Skip to Content
Erste SchrittePartner-OAuth

Partner-OAuth-Integration

Beta. Der OAuth-Modus wird schrittweise ausgerollt. Kontaktieren Sie uns, um Ihre App registrieren zu lassen.

Wenn Sie ofox in Ihr Produkt integrieren möchten, können Nutzer über einen OAuth-Button zu ofox wechseln, sich dort anmelden und die Berechtigung erteilen und anschließend zu Ihrer App zurückkehren. Neue Nutzer, die sich auf diese Weise registrieren, werden automatisch Ihrem Partner-Kanal zugeordnet – genau wie bei einer Registrierung über Ihren Empfehlungslink.

So binden Sie es an

Sie können sich auch bewerben, wenn Ihre App noch in Entwicklung ist – das Produkt muss nicht fertig sein. Die OAuth-Anbindung befindet sich in der Beta-Phase; die Registrierungsangaben werden vom Team geprüft.

  1. Falls Sie noch nicht am Partnerprogramm teilnehmen, bewerben Sie sich zuerst auf der Partner-Seite ; bereits beworbene oder aktivierte Partner müssen sich nicht erneut bewerben.
  2. Senden Sie die unten aufgeführten Registrierungsangaben an hi@ofox.ai oder antworten Sie auf eine bestehende Support-E-Mail.
  3. Nachdem wir App-Angaben, Callback-Adresse und benötigte Berechtigungen geprüft haben, registrieren wir die OAuth-App, verknüpfen sie mit Ihrem Empfehlungskanal und stellen Ihnen die Anbindungskonfiguration bereit.
  4. Setzen Sie OAuth 2.1 in Ihrem Produkt um und prüfen Sie Autorisierung, Rückkehr zur App und Modellaufrufe.

Für die Kanalzuordnung sind keine zusätzlichen Empfehlungsparameter nötig; wir konfigurieren sie bei der Registrierung. Callback-Adresse, Berechtigungen und Autorisierungsablauf von OAuth selbst müssen weiterhin gemäß der bereitgestellten Konfiguration umgesetzt werden.

Welche Angaben für die Registrierung nötig sind

AngabeWas beschrieben werden sollte
App-Name und ZweckEin vorläufiger Name genügt; beschreiben Sie Hauptfunktionen, Zielnutzer und wie Sie die Modelle von ofox nutzen
App-TypWeb, Desktop-Client, Mobile App, Browser-Erweiterung oder CLI-Tool; ob ein eigenes Backend existiert
OAuth-Callback-Adresse (Redirect URI)Vollständige Adresse für die Rückkehr zur App nach der Autorisierung; Test- und Produktionsumgebung bitte getrennt angeben. Die Adresse muss vor der Registrierung feststehen – ist sie noch offen, beschreiben Sie zunächst den technischen Ansatz
Partner-AngabenE-Mail-Adresse der Partnerprogramm-Bewerbung sowie Empfehlungslink oder -code; bereits in derselben E-Mail genannte Angaben müssen nicht wiederholt werden
Benötigte FunktionenOb Modellaufrufe, Anzeige von Guthaben oder Nutzung, Lesen von Organisationsdaten oder dauerhafte Anmeldung nötig sind; beschreiben Sie einfach den Bedarf, ohne selbst alle Berechtigungen auszuwählen
Produktlink und Logo (nachreichbar)Website, Repository, Demo-Seite oder Screenshots, falls vorhanden; ist das Produkt noch nicht live, reicht eine kurze Beschreibung, das Logo kann später folgen

Die Callback-Adresse muss exakt mit dem registrierten Wert übereinstimmen; Platzhalter werden nicht unterstützt. Protokoll, Domain, Port, Pfad und abschließender / müssen gleich sein. Für Web-Produktionsumgebungen wird HTTPS empfohlen. Bei Desktop-, Mobile- oder lokaler Entwicklung beschreiben Sie bitte bei der Registrierung, wie der Callback erfolgt.

Für eine Anfrage zur Anbindung müssen Sie weder den vollständigen Quellcode noch ein fertiges Produkt einreichen. Senden Sie in der Bewerbungs-E-Mail keine Passwörter, API Keys, Client Secrets oder Access Tokens.

Kopieren Sie die folgende Vorlage und markieren Sie noch offene Punkte mit „noch offen“:

App-Name: Zweck / Zielnutzer: App-Typ / Backend vorhanden: Callback-Adresse (Test): Callback-Adresse (Produktion): E-Mail der Partner-Bewerbung: Partner-Empfehlungslink oder -code: Benötigte Funktionen: Produktlink / Beschreibung (falls vorhanden): Logo (falls vorhanden):

Vor der Anbindung zu klären

  • Client-Typ: Apps mit Backend, das Geheimnisse sicher speichern kann, und Apps, die direkt im Browser, auf dem Desktop oder dem Smartphone laufen, werden unterschiedlich konfiguriert. Beschreiben Sie die tatsächliche Architektur; legen Sie das Client Secret niemals in Frontend-Code oder an Nutzer verteilte Installationspakete.
  • Berechtigungsumfang: Beantragen Sie nur die Berechtigungen, die Ihr Produkt tatsächlich benötigt. Für Modellaufrufe ist llm.invoke erforderlich; weitere Funktionen werden nach Bedarf abgestimmt, maßgeblich ist das tatsächliche Autorisierungsergebnis.
  • Integrationstests: Binden Sie nach der Registrierung gemäß der bereitgestellten Konfiguration an; bei Problemen nennen Sie bitte die Schritte, die bereinigte Fehlermeldung und den Zeitpunkt, senden Sie aber keine Tokens oder Schlüssel.

Was zugeordnet wird

Nur Neuregistrierungen. Klickt ein Nutzer ohne ofox-Konto auf Ihren OAuth-Button, gelangt er zur ofox-Anmeldeseite, wechselt zur Registrierung und schließt diese ab — in genau diesem Moment entsteht die Bindung an Ihren Kanal. Ab dann laufen seine Aufladungen und Nutzung über die normale Partner-Provisionsabrechnung.

Bei Nutzern mit bereits bestehendem ofox-Konto ändert sich die Zuordnung nicht. Die Autorisierung Ihrer App ändert daran nichts — auch dann nicht, wenn der Nutzer noch nie einem Partner zugeordnet war. Das gilt sowohl für bereits einem anderen Partner zugeordnete Nutzer als auch für Nutzer ganz ohne Zuordnung.

Das ist beabsichtigt: Eine Empfehlungsbindung gilt lebenslang und exklusiv für das Konto. Eine Neuzuordnung zuzulassen würde bedeuten, dass ein Partner die von einem anderen Partner gewonnenen Nutzer übernehmen könnte.

Scope beim ersten Aufruf

Das Access Token direkt nach der Registrierung enthält möglicherweise noch kein llm.invoke.

llm.invoke wird nur an Nutzer mit verifizierter E-Mail-Adresse vergeben. Ob das zum Zeitpunkt der Registrierung bereits zutrifft, hängt davon ab, wie der Nutzer sich registriert hat:

RegistrierungsartE-Mail bei Abschluss verifiziertllm.invoke im ersten Token
Passwortloser LinkJa — der Klick auf den Link ist die VerifizierungEnthalten
E-Mail + PasswortNoch nichtEntfernt, bis verifiziert

Wird ein Scope entfernt, ist die Token-Anfrage trotzdem erfolgreich — das Feld scope in der Antwort listet auf, was tatsächlich vergeben wurde (RFC 6749 §3.3). Lies dieses Feld, statt anzunehmen, du hättest alles Angeforderte erhalten. Ein Aufruf der LLM-API ohne llm.invoke liefert 403 insufficient_scope.

Sobald der Nutzer seine E-Mail verifiziert hat, fordere ein neues Token an (oder refresh), dann ist llm.invoke enthalten.

Provision

Zugeordnete Nutzer werden nach der gestaffelten Standard-Partnerprovision (bis zu 9 %) auf Basis der tatsächlichen API-Nutzung abgerechnet. Auszahlungen ab 50 $, monatliche Abrechnung. Aktuelle Konditionen finden Sie auf der Partner-Seite .

Zuletzt aktualisiert am