Gestisci le integrazioni del centro assistenza con l'API Notiondesk

Configura Google Analytics, Plausible, Umami, Intercom, Crisp, Help Scout e Google Tag Manager sul tuo centro assistenza Notiondesk tramite l'API REST.

4 min di lettura

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}/integrationsreadElenca i provider configurati
PATCH/sites/{site_id}/integrations/{type}adminConfigura un provider e lo attiva
POST/sites/{site_id}/integrations/{type}/disableadminDisattiva un fornitore

La configurazione e la disattivazione dei provider richiedono un piano che includa le integrazioni.

Ogni provider carica uno script di terze parti su ogni pagina del tuo centro assistenza. Un contenitore di Google Tag Manager esegue tutto ciò che il suo proprietario pubblica, e Plausible o Umami decidono da dove caricare lo script di analisi. Ecco perché la modifica delle integrazioni richiede un ambito di autorizzazione. Assegna una chiave solo alle integrazioni di cui ti fidi.proxy_urladminadmin

Fornitori supportati

typeCampo Necessario Formato Guida all'installazione
google-analyticstracking_idSÌ Un ID di misurazione di Google Analytics 4: G- e 10 lettere maiuscole o cifre, come G-ABCDEFGHIJ Google Analytics
plausible-analyticsdomainSÌ Il dominio del tuo sito registrato in Plausible Analisi plausibili
plausible-analyticsproxy_urlNO L'origine https da cui esegui il proxy dello script, ad esempio https://plausible.example.com
umamiwebsite_idSÌ Lettere, cifre, - e _ Umami
umamiproxy_urlNO L'origine https da cui esegui il proxy dello script, ad esempio https://umami.example.com
intercomapp_idSÌ Lettere, cifre, - e _ Citofono
crispapp_idSÌ Lettere, cifre, - e _ Croccante
helpscoutbeacon_idSÌ Lettere, cifre, - e _ Aiuta Scout
google-tag-managercontainer_idSÌ 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
typeIl fornitore
settingsI campi del fornitore. null quando il fornitore è stato attivato nella dashboard senza essere configurato
enabledSe 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.
Nota: un valore salvato prima dell'applicazione dei formati correnti, come un ID di Google Analytics o un valore non valido, non supera la convalida. Finché non invii un valore valido per quel campo, ogni aggiornamento di quel provider restituisce un errore 400, incluso.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 Quandocode
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 modificheinsufficient_scope
403 Il tuo piano non include integrazioni oppure il creatore della chiave non può modificare questo centro assistenzapermission_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?

No. L'API accetta solo gli ID di misurazione di Google Analytics 4, che iniziano con G-.

Cosa succederà dopo?

Articoli correlati

Questa pagina è stata utile?

Still need help? Ask us