ORYKSAORYKSADéveloppeurs
Obtenir des clés API

SDK Flutter

L'employé IA ORYKSA dans une application Flutter : le même chat que sur le site web, en quatre langues, avec un Brain qui apprend l'application.

Ce que fait le SDK et à quoi il sert

Il intègre la bulle de chat ORYKSA et la voix dans votre application, pour servir les clients de votre entreprise: ils posent des questions, achètent et réservent. L'IA répond avec votre Brain, vos produits et vos services, avec le nom, la photo et la voix que vous avez choisis dans Votre IA, et enregistre les leads, réservations et ventes dans les Activités de votre compte ORYKSA, comme WhatsApp ou le chat du site web.

Ce n'est pas une interface pour le propriétaire : via le SDK, personne ne modifie vos paramètres, ne lit vos Activités ou ne donne d'ordres à ORYKSA, même s'il se présente comme le propriétaire. Le chat où le propriétaire parle à ORYKSA existe uniquement dans l'application officielle ORYKSA, le tableau de bord et l'extension navigateur.

La voix depuis la version 1.1 (Android, iOS, Flutter et React Native), avec le même comportement que l'application ORYKSA. Les SDK JavaScript et .NET sont uniquement textuels.

Les gros mots saisis par le client apparaissent sous forme d'astérisques dans le chat (la même liste que tous les chats ORYKSA, depuis GET https://app.oryksa.com/widget/profanity.json) ; les réponses de l'IA sont déjà filtrées.

En savoir plus dans le Centre d'aide

PackageVersionPlateformesLicence
oryksa (pub.dev, GitHub)1.1.1Android, iOSMIT

Installer

flutter pub add oryksa

Exemple minimal

Un bouton flottant qui ouvre le chat. Le bouton affiche "Parler à <name>" avec la photo de l'employé IA, exactement comme le chat du site web.

import 'package:oryksa/oryksa.dart';

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

Scaffold(
  body: MyScreen(),
  floatingActionButton: OryksaChatButton(client: client, lang: 'en'), // en, pt, br, es
);

Éléments

ÉlémentCe qu'il fait
OryksaChatButton(client:, lang:)Bouton flottant avec la photo et le nom, ouvre le chat.
showOryksaChat(context, client:)Ouvre le chat depuis votre propre bouton.
OryksaChat(client:)Le panneau de chat intégré où vous le souhaitez.
OryksaChatThemeCouleurs.
client.agent(), client.sendAndWait(text), client.messages()Pas d'interface : détails de l'agent, envoi d'un message et attente de la réponse, historique des messages.

Côté serveur (Dart)

La clé API reste sur votre serveur. Votre backend crée les session tokens utilisés par l'application, et garde le Brain de l'agent synchronisé avec l'application grâce à learnApp.

import 'dart:io';
import 'package:oryksa/oryksa_server.dart';   // backend only: never import it in the app

final oryksa = Oryksa(Platform.environment['ORYKSA_API_KEY']!);
// short-lived token for one app user: send only client_token to the app
final 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: appScreens, faq: appFaq);
// webhooks: pass the RAW body
final event = verifyWebhook(rawBody, request.headers['oryksa-signature'], webhookSecret);

Ce que l'utilisateur voit

  • Le même aspect que le chat du site web : bouton avec la photo, en-tête avec le nom et « en ligne », bulles, suggestions, ENVOYER et « Powered by ORYKSA ».
  • Langues : en, pt (Portugal), br (Brésil), es. Le nom et la photo proviennent du profil « Votre IA » du propriétaire.
  • Voix (depuis 1.1) : le micro dans le chat ouvre l'écran vocal, avec le même comportement que l'application ORYKSA. Chaque réponse a un bouton copier.
Sécurité dès la conception. Ne mettez jamais la clé secrète dans le bundle de l'application. Utilisez getToken pour récupérer un jeton oryk_cs_... token depuis votre backend ; le SDK le rafraîchit à expiration.