ORYKSAORYKSADevelopers
Obter chaves de API

Endpoints do widget

Obtenha o código do chat para qualquer framework e limite o chat aos seus domínios.

Só para clientes. Este canal atende os clientes da empresa (perguntas, vendas, agendamentos) com o seu Brain, produtos e serviços. Nunca é uma interface do dono: não altera configurações, não lê Atividades nem aceita ordens do dono, mesmo que alguém diga que é o dono. O dono fala com a ORYKSA só no app ORYKSA oficial, no painel e na extensão do navegador. Saiba mais

Código

GET/v1/widget

framework: html, nextjs-app, nextjs-pages, react, vue, nuxt, astro, svelte, angular ou wordpress. Opcionais lang e position (left ou right). A resposta informa onde colar o código.

curl "https://api.oryksa.com/v1/widget?framework=nextjs-app&lang=en" -H "Authorization: Bearer oryk_live_YOUR_KEY"
{
  "object": "widget",
  "where": "app/layout.tsx: import Script from 'next/script' and add inside <body>.",
  "code": "<Script src=\"https://app.oryksa.com/static/oryksa-widget.js\" data-token=\"...\" data-lang=\"en\" strategy=\"afterInteractive\" />",
  "widget_token": "af66ff5ce932faf7b16f1dea324700f6",
  "voice_replies": true,
  "note": "The widget token is public by design (it only lets visitors chat)."
}

Domínios autorizados

PUT/v1/widget/domains

Até 20 domínios; os subdomínios estão incluídos. Uma lista vazia remove a restrição.

curl -X PUT https://api.oryksa.com/v1/widget/domains \
  -H "Authorization: Bearer oryk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domains": ["quintadovale.pt"]}'