Referência da API

Cada endpoint da API Notiondesk com seus parâmetros, respostas e exemplos de código.

A API REST Notiondesk permite que você execute suas centrais de ajuda a partir de código. Leia artigos, coleções e entradas de changelog, gerencie redirecionamentos de página, atualize configurações, identidade visual e integrações, exporte análises e feedback dos leitores e acione sincronizações do Notion. Você ainda escreve seu conteúdo no Notion: a API o lê e sincroniza, não o edita.

URL base

Envie todas as solicitações para https://api.notiondesk.so. Os caminhos dos endpoints começam com /sites, e as solicitações e respostas usam JSON.

Autenticação

Cada requisição carrega um token de portador no cabeçalho Authorization:

curl https://api.notiondesk.so/sites \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY"
  • Chave de API : para seus próprios scripts, tarefas agendadas e CI. O proprietário do espaço de trabalho ou um administrador a cria em Configurações > Desenvolvedores > Chaves de API. As chaves começam com nd_wsk_ e funcionam para todas as centrais de ajuda no espaço de trabalho. Consulte Autenticar com a API Notiondesk usando chaves de API .

Cada endpoint precisa de um escopo: read, write, sync ou admin. A página de cada endpoint mostra qual deles.

Exemplos de código

Cada página de endpoint lista seus parâmetros, corpo da requisição e respostas, com exemplos de código prontos para copiar em cURL, JavaScript e Python.

Guias

  • Webhooks : receba uma solicitação em seu servidor quando algo acontecer em Notiondesk.