Widget
Embeddable support widget for customer websites.
Script du widget
Section intitulée « Script du widget »GET /widget.js
Script to include in your website. It injects a floating support button that opens
the ticket form (/widget.html) in an iframe.
<script src="https://exocortex-api.ai-exo-cortex.com/widget.js?tenant=ACME&key=pk_live_3f9a1c2e" async></script>Authentification: Aucune : la requête est authentifiée par la signature décrite ci-dessus.
Paramètres
Section intitulée « Paramètres »| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
tenant |
query | string | oui | |
key |
query | string | oui | Public widget key. |
Réponses
Section intitulée « Réponses »| Statut | Description |
|---|---|
200 |
JavaScript loader. |
Exemple 200
(function(){ /* exoCortex widget loader */ })();Exemple avec curl
Section intitulée « Exemple avec curl »curl -X GET "https://exocortex-api.ai-exo-cortex.com/widget.js?tenant=ACME&key=pk_live_3f9a1c2e"Formulaire du widget
Section intitulée « Formulaire du widget »GET /widget.html
The HTML form rendered inside the widget iframe. You normally don’t call it directly; /widget.js loads it.
Authentification: Aucune : la requête est authentifiée par la signature décrite ci-dessus.
Paramètres
Section intitulée « Paramètres »| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
tenant |
query | string | oui | |
key |
query | string | oui | Public widget key. |
Réponses
Section intitulée « Réponses »| Statut | Description |
|---|---|
200 |
HTML document. |
Exemple 200
<!DOCTYPE html><html>…</html>Exemple avec curl
Section intitulée « Exemple avec curl »curl -X GET "https://exocortex-api.ai-exo-cortex.com/widget.html?tenant=ACME&key=pk_live_3f9a1c2e"Envoyer une demande depuis le widget
Section intitulée « Envoyer une demande depuis le widget »POST /api/v1/widget/submit
Used by the widget form. Limited to 30 submissions per hour per client IP and tenant.
If the tenant enabled Cloudflare Turnstile, a valid cf_turnstile_token is required.
Authentification: Clé publique du widget : X-NH-Widget-Key: pk_…
Corps de la requête
Section intitulée « Corps de la requête »application/json
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
tenant |
string | oui | Must match the widget key’s tenant. |
email |
string (email) | oui | |
name |
string | non | |
subject |
string | oui | |
description |
string | oui | |
category |
string | non | |
origin |
string | non | Page URL where the widget was used. |
cf_turnstile_token |
string | non | Cloudflare Turnstile token. Required if the tenant enabled Turnstile. You can also send it in the X-NH-Turnstile header. |
{ "tenant": "ACME", "name": "Maria Rossi", "subject": "Cannot download my invoice", "description": "The invoice page shows an empty PDF for October.", "category": "Billing", "origin": "https://www.example.com/account", "cf_turnstile_token": "0.xY2fake-turnstile-token"}Réponses
Section intitulée « Réponses »| Statut | Description |
|---|---|
200 |
Ticket created. |
400 |
Invalid request. |
401 |
Not authenticated. |
403 |
Authenticated but not allowed (role, tenant or key). |
429 |
Too many submissions from this IP (30 per hour). |
500 |
Unexpected server error. |
Exemple 200
{ "ok": true, "ticket_key": "ACME-1043", "ingestion_id": "ing_2c71f0aa"}Exemple avec curl
Section intitulée « Exemple avec curl »curl -X POST "https://exocortex-api.ai-exo-cortex.com/api/v1/widget/submit" \ -H "X-NH-Widget-Key: $EXO_WIDGET_KEY" \ -H "Content-Type: application/json" \ --data '{"tenant":"ACME","email":"[email protected]","name":"Maria Rossi","subject":"Cannot download my invoice","description":"The invoice page shows an empty PDF for October.","category":"Billing","origin":"https://www.example.com/account","cf_turnstile_token":"0.xY2fake-turnstile-token"}'Page générée à partir de la spécification OpenAPI de l’API d’intégration, version 1.1.0.