ORYKSAORYKSADevelopers
Obtener claves de API

SDK de Android (Kotlin)

El empleado de IA de ORYKSA dentro de una app Android: Jetpack Compose o Views, el mismo chat que el sitio web, en cuatro idiomas.

Qué hace el SDK y para qué sirve

Pone en tu app la burbuja de chat y la voz de ORYKSA para atender a los clientes de tu empresa: preguntan, compran y reservan. La IA responde con tu Brain, tus productos y tus servicios, con el nombre, la foto y la voz que elegiste en Tu IA, y guarda leads, reservas y ventas en las Actividades de tu cuenta ORYKSA, como en WhatsApp o en el chat del sitio.

No es una interfaz del dueño: por el SDK nadie cambia tus ajustes, lee tus Actividades ni da órdenes a ORYKSA, aunque diga que es el dueño. El chat en el que el dueño habla con ORYKSA existe solo en la app oficial de ORYKSA, el panel y la extensión del navegador.

Voz desde la versión 1.1 (Android, iOS, Flutter y React Native), con el mismo comportamiento que la app de ORYKSA. Los SDK de JavaScript y .NET son solo texto.

Las palabrotas que escribe el cliente aparecen con asteriscos en el chat (la misma lista de todos los chats de ORYKSA, en GET https://app.oryksa.com/widget/profanity.json); las respuestas de la IA ya vienen filtradas.

Más información en el Centro de Ayuda

PaqueteVersiónPlataformasLicencia
com.oryksa:sdk (Maven Central, JitPack, GitHub)1.1.1Android 6.0+ (minSdk 23)MIT

Instalar

Disponible en Maven Central (com.oryksa:sdk:1.1.1) y en 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")

Ejemplo mínimo

Un botón que abre la actividad del chat. El chat muestra el nombre y la foto del empleado de IA, exactamente como el chat del sitio.

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")

Piezas

PiezaQué hace
OryksaChatButton(client, onClick)Botón con la foto y el nombre; abre el chat.
OryksaChatActivityLa pantalla del chat (Compose o Views): OryksaChatActivity.open(context, lang).
OryksaChat(client)El panel de chat en Compose, incrustado donde quieras.
OryksaChatThemeColores.
client.agent(), client.sendAndWait(text), client.messages()Sin interfaz: datos del agente, enviar un mensaje y esperar la respuesta, historial de mensajes.

Qué ve el usuario

  • El mismo aspecto que el chat del sitio: botón con la foto, cabecera con el nombre y "online", burbujas, sugerencias, ENVIAR y "Powered by ORYKSA".
  • Idiomas: en, pt (Portugal), br (Brasil), es. El nombre y la foto vienen del perfil "Tu IA" del dueño.
  • Voz (desde la 1.1): el micrófono del chat abre la pantalla de voz, con el mismo comportamiento que la app de ORYKSA. Cada respuesta tiene un botón de copiar.
Seguridad de base. Nunca pongas la clave secreta en el paquete de la app. Usa getToken para pedir a tu backend un token oryk_cs_... de corta duración; el SDK lo renueva cuando caduca. Crea los tokens con la API de sesiones desde cualquier lenguaje de servidor.