Integração OAuth para parceiros
Beta. O modo OAuth está a ser lançado gradualmente. Fale connosco para registar a sua aplicação.
Se você planeja integrar o ofox ao seu produto, os usuários podem clicar em um botão OAuth, entrar e autorizar no ofox e depois voltar ao seu aplicativo. Novos usuários que se cadastram dessa forma são atribuídos automaticamente ao seu canal de partner — exatamente como se tivessem se cadastrado pelo seu link de indicação.
Como integrar
É possível solicitar mesmo com o aplicativo ainda em desenvolvimento; não é preciso esperar o produto ficar pronto. A integração OAuth está em Beta e os dados de registro são confirmados pela equipe.
- Se ainda não participa do programa de parceiros, solicite primeiro na página Partner ; parceiros que já solicitaram ou estão ativados não precisam solicitar de novo.
- Envie os dados de registro abaixo para hi@ofox.ai ou responda a um e-mail de suporte existente.
- Depois de confirmar os dados do aplicativo, o endereço de callback e as permissões necessárias, registramos o aplicativo OAuth, o vinculamos ao seu canal de indicação e fornecemos a configuração de integração.
- Conclua a integração OAuth 2.1 no seu produto e verifique a autorização, o retorno ao aplicativo e as chamadas de modelo.
A atribuição do canal não exige parâmetros de indicação adicionais; nós a configuramos no registro. O endereço de callback, as permissões e o fluxo de autorização do OAuth ainda precisam ser implementados conforme a configuração fornecida.
O que informar para registrar o aplicativo
O endereço de callback deve ser exatamente igual ao registrado; curingas não são suportados. Protocolo, domínio, porta, caminho e a / final precisam coincidir. Em produção web, recomenda-se HTTPS. Para desktop, mobile ou desenvolvimento local, explique o método de callback no registro.
Não é necessário enviar o código-fonte completo nem um produto finalizado para consultar sobre a integração. Não envie senhas, API Keys, Client Secrets ou Access Tokens no e-mail de solicitação.
Copie o modelo abaixo e marque como “a confirmar” o que ainda não estiver definido:
Nome do aplicativo:
Finalidade / público:
Tipo de aplicativo / tem backend:
Endereço de callback (teste):
Endereço de callback (produção):
E-mail da solicitação Partner:
Link ou código de indicação Partner:
Funções necessárias:
Link / descrição do produto (se houver):
Logo (se houver):O que confirmar antes de integrar
- Tipo de cliente: aplicativos com backend capaz de guardar segredos com segurança e aplicativos executados diretamente no navegador, desktop ou celular usam configurações diferentes. Descreva a arquitetura real; não coloque o Client Secret no código frontend nem em instaladores distribuídos aos usuários.
- Escopo de permissões: solicite apenas as permissões de que o produto realmente precisa. Chamar modelos exige
llm.invoke; o restante é confirmado conforme a necessidade, e as permissões concedidas seguem o resultado real da autorização. - Testes de integração: após o registro, integre conforme a configuração fornecida; se houver problemas, informe os passos, a mensagem de erro sem dados sensíveis e o horário, sem enviar tokens ou chaves.
O que é atribuído
Apenas novos registos. Quando um utilizador sem conta ofox clica no seu botão OAuth, é levado para a página de início de sessão do ofox, muda para o registo e conclui-o — é nesse momento que a associação ao seu canal é criada. A partir daí, os carregamentos e o consumo desse utilizador seguem a liquidação normal de comissões de parceiro.
Os utilizadores que já têm conta ofox mantêm a atribuição existente. Autorizar a sua aplicação não a altera — nem mesmo se esse utilizador nunca tiver sido atribuído a qualquer parceiro. Isto aplica-se tanto a utilizadores já associados a outro parceiro como a utilizadores sem qualquer associação.
Isto é deliberado: uma associação de indicação é permanente e exclusiva durante toda a vida da conta. Permitir a reassociação deixaria um parceiro ficar com os utilizadores angariados por outro.
Scope na primeira chamada
O access token recebido logo após o cadastro pode ainda não incluir llm.invoke.
llm.invoke só é concedido a usuários com o e-mail verificado. Se isso já é verdade no momento do cadastro depende de como o usuário se registrou:
Quando um scope é removido, a requisição de token ainda assim tem sucesso — o campo scope da resposta lista o que foi de fato concedido (RFC 6749 §3.3). Leia esse campo em vez de presumir que recebeu tudo o que pediu. Chamar a API de LLM sem llm.invoke retorna 403 insufficient_scope.
Depois que o usuário verificar o e-mail, solicite um novo token (ou faça refresh) e llm.invoke estará incluído.
Comissão
Os utilizadores atribuídos são liquidados com a comissão de parceiro escalonada padrão (até 9 %), com base na utilização real da API. Pagamentos a partir de 50 $, liquidação mensal. Consulte a página de Parceiros para as condições em vigor.