L'API Notiondesk ti permette di elencare tutti i centri di assistenza nel tuo spazio di lavoro, leggere la configurazione di ciascun centro di assistenza e controllare lo stato della sua sincronizzazione Notion pianificata. Inizia da qui: il centro di assistenza id restituito da questi percorsi è il site_id che ogni altro percorso dell'API Notiondesk prende nel suo percorso.
Nell'API Notiondesk, un centro assistenza è chiamato sito .
| Metodo | Sentiero | Ambito di applicazione | Fa |
|---|---|---|---|
GET | /sites | read | Elenca i centri di assistenza della tua area di lavoro |
GET | /sites/{site_id} | read | Legge un centro assistenza e le sue impostazioni |
GET | /sites/{site_id}/sync-status | read | Legge la sincronizzazione Notion programmata di un centro assistenza |
Elenca i tuoi centri di assistenza
L'elenco comprende tutti i centri di assistenza presenti nell'area di lavoro proprietaria della tua chiave, dal più vecchio al più recente, utilizzando la paginazione del cursore con page_size e cursor.
curl "https://api.notiondesk.so/sites?page_size=50" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"object": "list",
"data": [
{
"id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
"full_domain": "help.example.com",
"enabled": true,
"default_locale": "en",
"locales": ["en", "fr"]
}
],
"has_more": false,
"next_cursor": null
}| Campo | Tipo | Senso |
|---|---|---|
id | corda | L'identificativo del centro assistenza, utilizzato come site_id in ogni altro percorso |
full_domain | stringa o null | I lettori del dominio visitano: il tuo dominio personalizzato quando è attivo, altrimenti il tuo sottodominio Notiondesk |
enabled | booleano | Se il centro assistenza è abilitato |
default_locale | corda | La lingua predefinita, ad esempio en |
locales | elenco di stringhe | Le lingue supportate dal centro assistenza, visualizzate per impostazione predefinita, sono limitate al numero di lingue incluse nel tuo piano. |
Gestisci più centri di assistenza? Consulta la sezione Creare più centri di assistenza .
Leggere la configurazione di un centro assistenza
La risposta descrive il centro assistenza e ogni impostazione che l'API può modificare. Rileggila dopo un aggiornamento delle impostazioni per confermare il nuovo stato: le route delle impostazioni rispondono 204 No Content senza corpo.
curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
"full_domain": "help.example.com",
"enabled": true,
"default_locale": "en",
"access_mode": "public",
"guest_access_requires_login": true,
"supported_locales": ["en", "fr"],
"available_locales": ["en", "fr", "de", "es"],
"auto_sync_enabled": true,
"seo_indexing_enabled": true,
"setting_content_items": [
{"locale": "en", "page_title": "Example Help Center", "page_description": "Answers about Example"}
],
"auto_translate_enabled": false,
"auto_translate_source_locale": null,
"llms_txt_enabled": true,
"markdown_export_enabled": true,
"ai_contextual_menu_enabled": false,
"mcp_search_enabled": true,
"contact_form_enabled": true,
"changelog_enabled": true,
"changelog_email_subscriptions_enabled": false,
"changelog_reactions_enabled": true,
"changelog_email_subject_pattern": null,
"changelog_categories": [
{"category_id": "2984612035", "color": "blue_sky"}
]
}| Campo | Senso | Cambialo con |
|---|---|---|
id, full_domain, enabled, default_locale | Come nell'elenco sopra | default_locale: Lingue |
access_mode | Chi può leggere il centro assistenza: public, password o guest_accounts | Solo cruscotto |
guest_access_requires_login | Se un centro assistenza per account ospite chiede ai lettori di accedere | Solo cruscotto |
supported_locales | Le lingue supportate dal centro assistenza, di seguito l'impostazione predefinita | Lingue |
available_locales | Ogni lingua può essere configurata per servire un centro di assistenza | Non modificabile |
auto_sync_enabled | Se Notiondesk si sincronizza da Notion secondo una pianificazione | Sincronizzazioni |
seo_indexing_enabled | Se i motori di ricerca possono indicizzare il centro assistenza | Impostazioni |
setting_content_items | Titolo e descrizione della pagina per lingua: locale, page_title, page_description | Impostazioni |
auto_translate_enabled, auto_translate_source_locale | Se le traduzioni mancanti vengono prodotte automaticamente e da quale lingua | Lingue |
llms_txt_enabled, markdown_export_enabled, ai_contextual_menu_enabled | Se il centro assistenza pubblica llms.txt, offre articoli come markdown e mostra il menu contestuale dell'IA | Impostazioni |
mcp_search_enabled | Se la ricerca pubblica MCP del centro assistenza è attiva | Solo dashboard. Vedi Abilita la ricerca MCP |
contact_form_enabled | Se il centro assistenza mostra il suo modulo di contatto | Impostazioni |
changelog_enabled, changelog_email_subscriptions_enabled, changelog_reactions_enabled, changelog_email_subject_pattern, changelog_categories | Il registro delle modifiche e le sue opzioni. Ogni categoria del registro delle modifiche ha un category_id e un color | Impostazioni |
Verifica lo stato della sincronizzazione programmata
La risposta corrisponde allo stesso stato mostrato nella dashboard per le sincronizzazioni programmate:
curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/sync-status" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16"{
"auto_sync_enabled": true,
"frequency": "daily",
"next_sync_at": "2026-10-19T06:00:00+00:00",
"current_status": "idle",
"recent_runs": [
{
"started_at": "2026-10-18T06:00:02+00:00",
"finished_at": "2026-10-18T06:01:41+00:00",
"status": "success",
"message": "Synced successfully.",
"error_category": null,
"requires_customer_action": false
}
]
}| Campo | Senso |
|---|---|
auto_sync_enabled | Se la sincronizzazione pianificata è attiva |
frequency | daily, every_2h, hourly o auto; null quando la sincronizzazione pianificata è disattivata |
next_sync_at | Quando inizia la prossima sincronizzazione programmata; null quando non ne è prevista alcuna |
current_status | in_progress mentre è in corso un'esecuzione pianificata, failed quando l'ultima esecuzione non è riuscita, altrimenti idle |
recent_runs | Fino alle 10 corse programmate più recenti, dalla più recente alla meno recente. |
Ogni esecuzione ha started_at, finished_at (null mentre è in esecuzione e per un'esecuzione che è andata in timeout), status (in_progress, success o failed), un breve message e per un'esecuzione fallita:
error_category | Senso |
|---|---|
notion_connection | Notiondesk non è riuscito a raggiungere il tuo spazio di lavoro Notion, ad esempio dopo che la connessione è stata rimossa |
notion_configuration | I tuoi database o le tue pagine Notion non sono configurati come previsto da Notiondesk |
temporary_notion_issue | Notion ha avuto un problema temporaneo |
temporary_network_issue | Un problema temporaneo di rete ha interrotto l'esecuzione |
unknown | Qualsiasi altra causa |
Quando requires_customer_action è true, anche l'esecuzione successiva fallisce finché non si risolve un problema, ad esempio la connessione a Notion. Consulta la sezione Come sincronizzare il centro assistenza con Notion .
recent_runsErrori
| Stato | Quando | code |
|---|---|---|
| 400 | Su GET /sites: page_size è al di fuori dell'intervallo da 1 a 100, cursor non è valido oppure la query ha un parametro sconosciuto | validation_error |
| 403 | La chiave non ha l'ambito read | insufficient_scope |
| 404 | site_id non nomina alcun centro assistenza nel tuo spazio di lavoro | not_found |
Ogni percorso può anche rispondere a invalid_version, authentication_error, rate_limited e internal_error. Vedi Gestione degli errori API, dei limiti di frequenza e dei tentativi di ripetizione per Notiondesk .
Domande frequenti
Dove trovo il site_id del mio centro assistenza?
site_id del mio centro assistenza?Chiama GET /sites: l'id di ogni centro assistenza è il suo site_id. È anche l'identificativo dopo /s/ nella barra degli indirizzi della dashboard di Notiondesk.
Posso creare o eliminare un centro assistenza tramite l'API Notiondesk?
No. È possibile creare ed eliminare i centri assistenza nella dashboard. L'API legge e configura i centri assistenza già esistenti.
Posso modificare la frequenza di sincronizzazione tramite API?
No. L'API attiva o disattiva la sincronizzazione programmata. Modifica la frequenza nella dashboard.
Perché il centro assistenza elenca meno lingue di quelle che ho configurato?
I servizi locales e supported_locales sono limitati al numero di lingue incluse nel tuo piano tariffario. Le lingue che superano tale limite non sono supportate.