L'API Notiondesk consente di elencare, configurare e disattivare le integrazioni di terze parti del centro assistenza: provider di analisi, chat in tempo reale e gestione dei tag. Utilizzala per implementare la stessa configurazione di analisi o chat su più centri assistenza con un unico script.
| Metodo | Sentiero | Ambito di applicazione | Fa |
|---|---|---|---|
GET | /sites/{site_id}/integrations | read | Elenca i provider configurati |
PATCH | /sites/{site_id}/integrations/{type} | admin | Configura un provider e lo attiva |
POST | /sites/{site_id}/integrations/{type}/disable | admin | Disattiva un fornitore |
La configurazione e la disattivazione dei provider richiedono un piano che includa le integrazioni.
proxy_urladminadminFornitori supportati
type | Campo | Necessario | Formato | Guida all'installazione |
|---|---|---|---|---|
google-analytics | tracking_id | SÌ | Un ID di misurazione di Google Analytics 4: G- e 10 lettere maiuscole o cifre, come G-ABCDEFGHIJ | Google Analytics |
plausible-analytics | domain | SÌ | Il dominio del tuo sito registrato in Plausible | Analisi plausibili |
plausible-analytics | proxy_url | NO | L'origine https da cui esegui il proxy dello script, ad esempio https://plausible.example.com | |
umami | website_id | SÌ | Lettere, cifre, - e _ | Umami |
umami | proxy_url | NO | L'origine https da cui esegui il proxy dello script, ad esempio https://umami.example.com | |
intercom | app_id | SÌ | Lettere, cifre, - e _ | Citofono |
crisp | app_id | SÌ | Lettere, cifre, - e _ | Croccante |
helpscout | beacon_id | SÌ | Lettere, cifre, - e _ | Aiuta Scout |
google-tag-manager | container_id | SÌ | Lettere, cifre, - e _, come GTM-ABC123 | Google Tag Manager |
Ogni valore è una stringa di massimo 255 caratteri. Nessuno di essi è segreto: ognuno è un identificatore necessario allo script del provider nella pagina. Notiondesk verifica il formato, ma non l'ID stesso, con il provider.
Elenca le tue integrazioni
curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"object": "list",
"data": [
{
"type": "plausible-analytics",
"settings": {"domain": "help.example.com", "proxy_url": null},
"enabled": true
},
{
"type": "crisp",
"settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
"enabled": false
}
],
"has_more": false,
"next_cursor": null
}| Campo | Senso |
|---|---|
type | Il fornitore |
settings | I campi del fornitore. null quando il fornitore è stato attivato nella dashboard senza essere configurato |
enabled | Se il centro assistenza carica il fornitore |
L'elenco comprende i provider disattivati, senza un ordine particolare, e rientra sempre in una singola risposta. I provider che non sono mai stati configurati sono assenti.
Configura un provider
Invia i campi del provider al suo percorso. Il percorso risponde 200 OK con l'integrazione.
curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"domain": "help.example.com"}'{
"type": "plausible-analytics",
"settings": {"domain": "help.example.com", "proxy_url": null},
"enabled": true
}- Un aggiornamento attiva sempre il provider. Non esiste il campo
enabled: per disattivare un provider, utilizzare il percorso disable.
- Un campo che si omette mantiene il valore memorizzato. Per riattivare un provider configurato senza modificarlo, inviare
{}.
- Per rimuovere un proxy, inviare
"proxy_url": null.
- Ogni aggiornamento aggiorna l'intero centro assistenza, cancellando le pagine memorizzate nella cache e ricostruendo ogni pagina.
UA-proxy_urlhttpsvalidation_error{}Disattivare un fornitore
Il percorso risponde con 204 No Content e il centro assistenza smette di caricare il provider. Le sue impostazioni vengono mantenute, quindi l'elenco lo mostra ancora con enabled: false e {} inviato al suo percorso di aggiornamento lo riattiva.
Disattivare un provider già disattivato o uno che non è mai stato configurato non cambia nulla, risponde comunque a 204, quindi riprovare è sempre sicuro.
Errori
curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"| Stato | Quando | code |
|---|---|---|
| 400 | Un campo obbligatorio è mancante o vuoto, un valore non corrisponde al formato o è più lungo di 255 caratteri, un valore memorizzato non rispetta il formato e viene omesso dal corpo del messaggio, oppure il corpo del messaggio contiene un campo sconosciuto. | validation_error |
| 403 | La chiave non ha l'ambito read o admin per le modifiche | insufficient_scope |
| 403 | Il tuo piano non include integrazioni oppure il creatore della chiave non può modificare questo centro assistenza | permission_denied |
| 404 | Il centro assistenza non è presente nel tuo spazio di lavoro oppure type non è un provider supportato. | not_found |
Consultare la sezione "Errori API, limiti di frequenza e tentativi" dell'handle Notiondesk per informazioni sull'intestazione dell'errore e sugli altri codici.
Domande frequenti
Posso aggiungere uno script personalizzato con l'API Notiondesk?
No. Il codice JavaScript personalizzato viene impostato solo nella dashboard. Vedi Potenzia il tuo centro assistenza con il codice JavaScript personalizzato .
Perché la mia chiave non riesce a configurare le integrazioni?
La modifica delle integrazioni richiede l'ambito admin, che è posseduto solo dalle chiavi create dal proprietario dell'area di lavoro o dall'amministratore. Il piano deve includere anche le integrazioni.
Disabilitando un'integrazione, le relative impostazioni vengono eliminate?
No. Le impostazioni vengono mantenute e l'invio di {} al percorso di aggiornamento del provider lo riattiva presso di loro.
Posso utilizzare un ID UA- di Universal Analytics?
UA- di Universal Analytics?No. L'API accetta solo gli ID di misurazione di Google Analytics 4, che iniziano con G-.