Comece a usar a API REST Notiondesk

A API REST Notiondesk permite que seu próprio código opere suas centrais de ajuda. Você pode listar suas centrais de ajuda, ler seus artigos, coleções e histórico de alterações, gerenciar redirecionamentos de página, alterar configurações e identidade visual, obter análises e feedback dos leitores e acionar sincronizações do Notion.

Este artigo explica o que a API Notiondesk pode fazer, quem pode usá-la e como fazer sua primeira solicitação em poucos minutos.

O que você pode fazer com a API Notiondesk

Para scripts prontos para uso, consulte Automatizar tarefas comuns da central de ajuda com a API Notiondesk .

Quem pode usar a API Notiondesk?

• Plano: O acesso à API está incluído nos planos Enterprise.

• Criação de chaves: Proprietários e administradores de espaços de trabalho criam chaves de API no painel de controle.

• Permissões: Uma chave ou um aplicativo nunca pode fazer mais do que a pessoa por trás dele pode fazer em seu espaço de trabalho. Consulte Autenticar com a API Notiondesk usando chaves de API .

Faça sua primeira solicitação à API Notiondesk

1. Crie uma chave de API

No seu painel de controle do Notiondesk, abra Configurações , depois Desenvolvedores > Chaves de API e clique em Criar chave . Dê um nome à chave, selecione o escopo de leitura e copie-a quando ela for exibida. A chave começa com nd_wsk_ e é exibida apenas uma vez.

Armazene-o em uma variável de ambiente:

2. Liste seus centros de ajuda.

A resposta lista todos os centros de ajuda em seu espaço de trabalho:

3. Liste os artigos de uma central de ajuda.

Pronto! Você está lendo a central de ajuda a partir do código.

Noções básicas da API Notiondesk

export NOTIONDESK_API_KEY="nd_wsk_..."

curl "<https://api.notiondesk.so/sites>" \
  -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
}

curl "<https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=10>" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

API Notiondesk ou Workspace MCP?

O Notiondesk oferece duas maneiras de operar suas centrais de ajuda fora do painel de controle. Elas acessam os mesmos recursos por meio de abordagens diferentes.

Endpoint da API Notiondesk

Perguntas frequentes

O que vem a seguir?

• Autentique-se com a API Notiondesk usando chaves de API.

• Conecte seu aplicativo ao Notiondesk com OAuth

• Lidar com erros da API Notiondesk, limites de taxa e novas tentativas.

• Automatize tarefas comuns da central de ajuda com a API Notiondesk