ORYKSAORYKSADevelopers
Obtener claves de API

SDK de .NET (escritorio y servidores)

ORYKSA para apps .NET en Windows, Linux y macOS, y para backends .NET: cliente, ayudas de servidor y verificación de webhooks.

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
Oryksa (GitHub)1.0.0netstandard2.0, net8.0MIT

Instalar

El paquete NuGet Oryksa se está publicando; hasta que aparezca en el listado, añade el proyecto desde GitHub (submódulo git o referencia de proyecto).

dotnet add package Oryksa

Ejemplo mínimo

Lado del cliente (app de escritorio): habla con el empleado de IA sin interfaz propia. Para una ventana de chat lista en el escritorio, muestra el chat del sitio en un WebView2, o usa el SDK de JavaScript en Electron o Tauri.

using Oryksa;

// The app never holds the API key: your backend creates short-lived
// session tokens (oryk_cs_...) with POST /v1/sessions and hands them over.
var client = new OryksaClient(getToken: async ct => await MyBackend.FetchOryksaTokenAsync(ct));

var agent = await client.AgentAsync();                                   // name and photo of the AI
var reply = await client.SendAndWaitAsync("Are you open on Saturday?");  // one question, one answer
Console.WriteLine($"{agent.Name}: {reply.Text}");

Lado del servidor (backend .NET): la clave de API se queda en el servidor, crea tokens de sesión para tus apps, enseña el negocio y verifica webhooks.

using Oryksa;

var oryksa = new OryksaServer(Environment.GetEnvironmentVariable("ORYKSA_API_KEY")!);
var session = await oryksa.CreateSessionAsync(visitor: "user_42", lang: "pt");   // -> oryk_cs_...
await oryksa.SetPagesAsync(pages);        // teaches the business (Knowledge API)
await oryksa.AddFaqAsync(question, answer);
var ok = OryksaWebhook.Verify(rawBody, signatureHeader, secret);

Piezas

PiezaQué hace
OryksaClient: AgentAsync(), SendAndWaitAsync(text), MessagesAsync()Datos del agente (nombre, foto), enviar un mensaje y esperar la respuesta, historial de mensajes.
OryksaServer: CreateSessionAsync(), SetPagesAsync(), AddFaqAsync()Tokens de sesión, páginas y FAQs para el Brain.
OryksaWebhook.Verify()Verificación de la firma de los webhooks.
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.