Points de terminaison du widget

Obtenez le snippet de chat pour n'importe quel framework et verrouillez le chat sur vos domaines.

Pour les clients uniquement. Ce canal sert les clients de l'entreprise (questions, ventes, réservations) avec votre Brain, vos produits et services. Ce n'est jamais une interface pour le propriétaire : il ne modifie pas les paramètres, ne lit pas les Activités ni ne donne d'ordre au propriétaire, même si quelqu'un prétend l'être. Le propriétaire parle à ORYKSA uniquement dans l'application officielle ORYKSA, le dashboard et l'extension navigateur. Plus

Snippet

GET/v1/widget

framework: html, nextjs-app, nextjs-pages, react, vue, nuxt, astro, svelte, angular ou wordpress. Optionnel lang et position (gauche ou droite). La réponse indique où coller le code.

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

Domaines autorisés

PUT/v1/widget/domains

Jusqu'à 20 domaines ; les sous-domaines sont inclus. Une liste vide supprime la restriction.

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"]}'