ORYKSAORYKSADevelopers
Obter chaves de API

SDK React Native

O colaborador de IA da ORYKSA dentro de um app React Native ou Expo: o mesmo chat do site, em quatro idiomas, sem código nativo.

O que o SDK faz e para que serve

Coloca no seu app o balão de chat e a voz da ORYKSA para atender os clientes da sua empresa: eles perguntam, compram e agendam. A IA responde com o seu Brain, os seus produtos e os seus serviços, com o nome, a foto e a voz que você escolheu em Sua IA, e registra leads, agendamentos e vendas nas Atividades da sua conta ORYKSA, como no WhatsApp ou no chat do site.

Não é uma interface do dono: pelo SDK ninguém altera as suas configurações, lê as suas Atividades ou dá ordens à ORYKSA, mesmo dizendo que é o dono. O chat em que o dono fala com a ORYKSA existe só no app ORYKSA oficial, no painel e na extensão do navegador.

Voz desde a versão 1.1 (Android, iOS, Flutter e React Native), com o mesmo comportamento do app ORYKSA. Os SDKs JavaScript e .NET são só texto.

Os palavrões que o cliente digita aparecem com asteriscos no chat (a mesma lista de todos os chats da ORYKSA, em GET https://app.oryksa.com/widget/profanity.json); as respostas da IA já vêm filtradas.

Saiba mais na Central de Ajuda

PacoteVersãoPlataformasLicença
@oryksa/react-native (npm, GitHub)1.1.1Android, iOS, Expo (chat de texto no Expo Go; a voz precisa de módulos nativos ou do seu adaptador de áudio)MIT

Instalar

npm install @oryksa/react-native

Os tipos TypeScript já vêm incluídos. Alternativa direta do GitHub: npm install github:oryksa/oryksa-react-native#v1.1.1.

Exemplo mínimo

Um botão flutuante que abre o chat. O botão mostra "Falar com <nome>" com a foto do colaborador de IA, exatamente como o chat do site.

import { OryksaClient, OryksaChatButton } from "@oryksa/react-native";

// The app never holds the API key: your backend creates short-lived
// session tokens (oryk_cs_...) with POST /v1/sessions and hands them over.
const client = new OryksaClient({
  getToken: async () => {
    const r = await fetch("https://your-server.example/oryksa-token");
    return (await r.json()).token;
  },
});

export default function App() {
  return (
    <>
      <MyScreen />
      <OryksaChatButton client={client} lang="en" />   {/* en, pt, br, es */}
    </>
  );
}

Peças

PeçaO que faz
<OryksaChatButton client lang />Botão flutuante com a foto e o nome; abre o chat.
<OryksaChatModal client visible onClose />Abre o chat a partir de um botão seu.
<OryksaChat client />O painel de chat dentro de qualquer tela.
theme={{ accent: "#5B57E0" }}Cores.
client.agent(), client.sendAndWait(text), client.messages()Sem interface: dados do agente, enviar uma mensagem e aguardar a resposta, histórico de mensagens.

Lado do servidor (Node)

A chave de API fica no seu servidor. Com o @oryksa/sdk seu backend cria os tokens de sessão que o app usa e mantém o Brain do agente sincronizado com o app por meio do learnApp.

import { Oryksa, verifyWebhook } from "@oryksa/sdk";   // server side, Node

const oryksa = new Oryksa(process.env.ORYKSA_API_KEY);
// short-lived token for one app user: send only client_token to the app
const session = await oryksa.createSession({ conversationId: "user-42", customerName: "Ana" });
// keep the Brain in sync with the app (call it on every release)
await oryksa.learnApp({ name: "My app", screens, faq });
// webhooks: pass the RAW body
const event = await verifyWebhook(rawBody, req.headers["oryksa-signature"], webhookSecret);

O que o usuário vê

  • O mesmo visual do chat do site: botão com a foto, cabeçalho com o nome e "online", balões, sugestões, ENVIAR e "Powered by ORYKSA".
  • Idiomas: en, pt (Portugal), br (Brasil), es. O nome e a foto vêm do perfil "Sua IA" do dono.
  • Voz (desde a 1.1): o microfone no chat abre a tela de voz, com o mesmo comportamento do app ORYKSA. Cada resposta tem um botão de copiar.
Segurança desde a base. Nunca coloque a chave secreta no pacote do app. Use o getToken para buscar no seu backend um token oryk_cs_... de curta duração; o SDK renova o token ao receber um 401.