Riferimento API

Ogni endpoint API Notiondesk con i relativi parametri, risposte ed esempi di codice.

L'API REST Notiondesk ti permette di gestire i tuoi centri di assistenza tramite codice. Leggi articoli, raccolte e voci del registro delle modifiche, gestisci i reindirizzamenti di pagina, aggiorna le impostazioni, il branding e le integrazioni, esporta analisi e feedback dei lettori e attiva le sincronizzazioni da Notion. Scrivi comunque i tuoi contenuti in Notion: l'API li legge e li sincronizza, non li modifica.

URL di base

Invia ogni richiesta a https://api.notiondesk.so. I percorsi degli endpoint iniziano con /sites e le richieste e le risposte utilizzano il formato JSON.

Autenticazione

Ogni richiesta contiene un token bearer nell'intestazione Authorization:

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"
  • Chiave API : per i tuoi script, processi pianificati e CI. Il proprietario dell'area di lavoro o un amministratore la crea in Impostazioni > Sviluppatori > Chiavi API. Le chiavi iniziano con nd_wsk_ e funzionano per tutti i centri di assistenza nell'area di lavoro. Vedi Autenticazione con l'API Notiondesk tramite chiavi API .

Ogni endpoint necessita di un ambito: read, write, sync o admin. La pagina di ciascun endpoint indica quale ambito è necessario.

Esempi di codice

Ogni pagina dell'endpoint elenca i parametri, il corpo della richiesta e le risposte, con esempi di codice pronti da copiare in cURL, JavaScript e Python.

Guide

  • Guide introduttive : chiavi API, OAuth, paginazione e versioni, errori e limiti di frequenza, ed esempi.
  • Webhook : ricevi una richiesta sul tuo server quando succede qualcosa in Notiondesk.