SDK Android (Kotlin)
O colaborador de IA da ORYKSA dentro de uma app Android: Jetpack Compose ou Views, o mesmo chat do site, em quatro línguas.
O que o SDK faz e para que serve
Põe na tua app o balão de chat e a voz da ORYKSA para atender os clientes da tua empresa: perguntam, compram e marcam. A IA responde com o teu Brain, os teus produtos e os teus serviços, com o nome, a foto e a voz que escolheste em A tua IA, e grava leads, marcações e vendas nas Atividades da tua conta ORYKSA, como no WhatsApp ou no chat do site.
Não é uma interface do dono: pelo SDK ninguém muda as tuas definições, lê as tuas Atividades ou dá ordens à ORYKSA, mesmo que diga que é o dono. O chat em que o dono fala com a ORYKSA existe só na app ORYKSA oficial, no painel e na extensão do browser.
Voz desde a versão 1.1 (Android, iOS, Flutter e React Native), com o mesmo comportamento da app ORYKSA. Os SDKs JavaScript e .NET são só texto.
Os palavrões que o cliente escreve 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.
| Pacote | Versão | Plataformas | Licença |
|---|---|---|---|
com.oryksa:sdk (Maven Central, JitPack, GitHub) | 1.1.1 | Android 6.0+ (minSdk 23) | MIT |
Instalar
Disponível no Maven Central (com.oryksa:sdk:1.1.1) e no JitPack.
// build.gradle.kts (app): Maven Central is in the default repositories
implementation("com.oryksa:sdk:1.1.1")
// Alternative, JitPack:
// settings.gradle.kts -> repositories { maven("https://jitpack.io") }
// implementation("com.github.oryksa:oryksa-android:1.1.1")
Exemplo mínimo
Um botão que abre a atividade do chat. O chat mostra o nome e a foto do colaborador de IA, exatamente como o chat do site.
import com.oryksa.sdk.*
// The app never holds the API key: your backend creates short-lived
// session tokens (oryk_cs_...) with POST /v1/sessions and hands them over.
val client = OryksaClient(getToken = { myBackend.fetchOryksaToken() })
OryksaChatActivity.client = client
@Composable
fun MyScreen() {
val context = LocalContext.current
OryksaChatButton(client = client, onClick = {
OryksaChatActivity.open(context, lang = "en") // en, pt, br, es
})
}
// Apps with Views: OryksaChatActivity.open(this, "en")
Peças
| Peça | O que faz |
|---|---|
OryksaChatButton(client, onClick) | Botão com a foto e o nome; abre o chat. |
OryksaChatActivity | O ecrã do chat (Compose ou Views): OryksaChatActivity.open(context, lang). |
OryksaChat(client) | O painel de chat em Compose, embutido onde quiseres. |
OryksaChatTheme | Cores. |
client.agent(), client.sendAndWait(text), client.messages() | Sem interface: dados do agente, enviar uma mensagem e esperar a resposta, histórico de mensagens. |
O que o utilizador vê
- O mesmo aspeto 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".
- Línguas:
en,pt(Portugal),br(Brasil),es. O nome e a foto vêm do perfil "A tua IA" do dono. - Voz (desde a 1.1): o microfone no chat abre o ecrã de voz, com o mesmo comportamento da app ORYKSA. Cada resposta tem um botão de copiar.
getToken para ir buscar ao teu backend um token oryk_cs_... de curta duração; o SDK renova-o quando expira. Cria os tokens com a API de sessões a partir de qualquer linguagem de servidor.
