ORYKSAORYKSADevelopers
Obter chaves de API

SDK Swift (iOS e macOS)

O colaborador de IA da ORYKSA dentro de uma app iOS ou macOS: SwiftUI e UIKit, o mesmo chat do site, em quatro línguas, sem dependências.

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.

Saber mais no Centro de Ajuda

PacoteVersãoPlataformasLicença
Oryksa (GitHub)1.1.1iOS 15+, macOS 12+MIT

Instalar

No Xcode: File > Add Package Dependencies, cola o URL do repositório e escolhe 1.1.1. Ou acrescenta ao teu Package.swift; no CocoaPods adiciona o pod a partir do registo público.

// Package.swift
.package(url: "https://github.com/oryksa/oryksa-swift", from: "1.1.1")

# CocoaPods (https://cocoapods.org/pods/Oryksa)
pod 'Oryksa', '~> 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 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.
let client = OryksaClient(getToken: { try await MyBackend.fetchOryksaToken() })

struct ContentView: View {
    var body: some View {
        MyScreen()
            .overlay(alignment: .bottomTrailing) {
                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.
OryksaChatView(client:)O painel de chat em SwiftUI, onde quiseres.
OryksaChatViewController(client:)O mesmo painel para apps UIKit.
OryksaChatThemeCores.
client.agent(), client.sendAndWait(_:), 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.
Segurança de raiz. Nunca ponhas a chave secreta no pacote da app. Usa o 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.