Skip to Content
Начало работыOAuth для партнёров

Интеграция OAuth для партнёров

Beta. Режим OAuth разворачивается постепенно. Свяжитесь с нами, чтобы зарегистрировать ваше приложение.

Если вы планируете встроить ofox в свой продукт, пользователи смогут нажать кнопку OAuth, войти и выдать доступ в ofox, а затем вернуться в ваше приложение. Новые пользователи, зарегистрировавшиеся таким образом, автоматически засчитываются в ваш partner-канал — так же, как при регистрации по вашей реферальной ссылке.

Как подключиться

Подать заявку можно, пока приложение ещё в разработке — ждать готовности продукта не нужно. Подключение OAuth находится в стадии Beta, регистрационные данные проверяет команда.

  1. Если вы ещё не участвуете в партнёрской программе, сначала подайте заявку на странице Partner ; партнёрам, которые уже подали заявку или активированы, повторно подавать её не нужно.
  2. Отправьте регистрационные данные (см. ниже) на hi@ofox.ai или ответьте на уже имеющееся письмо поддержки.
  3. Проверив данные приложения, адрес обратного вызова и нужные разрешения, мы зарегистрируем OAuth-приложение, привяжем его к вашему каналу и передадим параметры подключения.
  4. Реализуйте OAuth 2.1 в своём продукте и проверьте авторизацию, возврат в приложение и вызов моделей.

Для атрибуции канала не нужно добавлять реферальные параметры — мы настраиваем её при регистрации. Адрес обратного вызова, разрешения и процесс авторизации OAuth всё равно реализуются по выданным параметрам подключения.

Что нужно для регистрации приложения

ДанныеЧто указать
Название и назначение приложенияМожно рабочее название; опишите основные функции, целевых пользователей и то, как вы используете модели ofox
Тип приложенияВеб, настольный клиент, мобильное приложение, расширение браузера или CLI-инструмент; есть ли собственный бэкенд
Адрес обратного вызова OAuth (Redirect URI)Полный адрес возврата в приложение после авторизации; укажите отдельно для тестовой и рабочей среды. Адрес нужно подтвердить до регистрации — если он ещё не определён, сначала опишите техническую схему
Данные партнёраEmail, указанный при заявке в партнёрскую программу, и реферальная ссылка или код; то, что уже есть в этом же письме, повторно присылать не нужно
Нужные функцииНужны ли вызов моделей, отображение баланса или использования, чтение данных организации, сохранение входа; просто опишите потребности, выбирать все разрешения самостоятельно не нужно
Ссылка на продукт и логотип (можно позже)Сайт, репозиторий, демо-страница или скриншоты, если есть; если продукт ещё не запущен, достаточно краткого описания, логотип можно прислать позже

Адрес обратного вызова должен полностью совпадать с зарегистрированным, подстановочные знаки не поддерживаются: протокол, домен, порт, путь и завершающий / должны совпадать. Для рабочей веб-среды рекомендуется HTTPS. Для настольных, мобильных приложений или локальной разработки опишите способ обратного вызова при регистрации.

Чтобы обсудить подключение, не нужно заранее присылать полный исходный код или готовый продукт. Не отправляйте в заявке пароли, API Key, Client Secret или Access Token.

Скопируйте шаблон ниже; пункты, которые ещё не определены, отметьте «уточняется»:

Название приложения: Назначение / целевые пользователи: Тип приложения / есть ли бэкенд: Адрес обратного вызова (тест): Адрес обратного вызова (прод): Email заявки Partner: Реферальная ссылка или код Partner: Нужные функции: Ссылка на продукт / описание (если есть): Логотип (если есть):

Что проверить до подключения

  • Тип клиента: приложения с бэкендом, способные безопасно хранить секреты, и приложения, работающие прямо в браузере, на компьютере или телефоне, подключаются по-разному. Опишите фактическую архитектуру; не помещайте Client Secret во фронтенд-код или в устанавливаемые пользователями пакеты.
  • Область разрешений: запрашивайте только те разрешения, которые реально нужны продукту. Для вызова моделей нужен llm.invoke; остальное согласуется по потребностям, а выданные разрешения определяются фактическим результатом авторизации.
  • Отладка подключения: после регистрации подключайтесь по выданным параметрам; при проблемах сообщите шаги, текст ошибки без конфиденциальных данных и время, но не присылайте токены и ключи.

Что засчитывается

Только новые регистрации. Когда пользователь без аккаунта ofox нажимает вашу кнопку OAuth, он попадает на страницу входа ofox, переключается на регистрацию и завершает её — именно в этот момент создаётся привязка к вашему каналу. Далее его пополнения и расход идут через обычный расчёт партнёрского вознаграждения.

У пользователей с уже существующим аккаунтом ofox привязка не меняется. Авторизация вашего приложения её не изменит — даже если этот пользователь никогда не был привязан ни к одному партнёру. Это касается как пользователей, уже привязанных к другому партнёру, так и пользователей вовсе без привязки.

Это сделано намеренно: реферальная привязка постоянна и эксклюзивна на всё время жизни аккаунта. Разрешив перепривязку, мы позволили бы одному партнёру забрать пользователей, приведённых другим.

Scope при первом вызове

Access token, полученный сразу после регистрации, может ещё не содержать llm.invoke.

llm.invoke выдаётся только пользователям с подтверждённым адресом электронной почты. Подтверждён ли он уже на момент регистрации, зависит от того, каким способом пользователь зарегистрировался:

Способ регистрацииПочта подтверждена по завершенииllm.invoke в первом token
Ссылка без пароляДа — переход по ссылке и есть подтверждениеВыдаётся
Почта + парольЕщё нетОтбрасывается до подтверждения

Если scope отброшен, запрос token всё равно завершается успешно — поле scope в ответе перечисляет то, что было выдано фактически (RFC 6749 §3.3). Читайте это поле, а не исходите из того, что получили всё запрошенное. Вызов LLM API без llm.invoke вернёт 403 insufficient_scope.

После того как пользователь подтвердит почту, запросите новый token (или обновите его) — llm.invoke будет включён.

Вознаграждение

Привязанные пользователи рассчитываются по стандартному многоступенчатому партнёрскому вознаграждению (до 9 %) на основе фактического использования API. Выплаты от $50, расчёт ежемесячный. Актуальные условия — на странице для партнёров .

Обновлено