api
Comece a usar a API REST NotiondeskUse a API REST Notiondesk para ler o conteúdo da central de ajuda, gerenciar redirecionamentos e configurações, obter análises e acionar sincronizações do Notion a partir do código.
Autentique-se com a API Notiondesk usando chaves de API.Crie uma chave de API Notiondesk, escolha os escopos de leitura, gravação, sincronização ou administração e autentique as solicitações da API REST com um token de portador. Alterne ou revogue a chave a qualquer momento.
Conecte seu aplicativo ao Notiondesk com OAuthCrie um aplicativo OAuth Notiondesk: registre um cliente, execute o fluxo de código de autorização OAuth 2.0 com PKCE, tokens de atualização e chame a API REST.
Paginar e versão Notiondesk solicitações de APINavegue pelas listas da API Notiondesk com page_size e cursor, fixe uma versão com o cabeçalho nd-version e use nomes de campo em snake_case.
Lidar com erros da API Notiondesk, limites de taxa e novas tentativas.Códigos de erro e envelope da API Notiondesk, limites de taxa de 120 leituras e 20 gravações por minuto, Retry-After e novas tentativas seguras com Idempotency-Key.
Leia as centrais de ajuda com a API NotiondeskListe seus centros de ajuda do Notiondesk, leia o domínio, os idiomas e as configurações deles e verifique o status da sincronização agendada do Notion com a API do Notiondesk.
Leia artigos, coleções e entradas do changelog com a API NotiondeskLeia artigos e coleções da central de ajuda do Notiondesk em formato Markdown, em qualquer idioma, com estado sincronizado, e liste as entradas do changelog através da API REST.
O Trigger Notion sincroniza com a API NotiondeskSincronize sua central de ajuda do Notiondesk do Notion por meio da API: acione uma sincronização de site, coleção ou artigo e ative ou desative a sincronização agendada.
Gerencie redirecionamentos de página com a API NotiondeskCrie, liste, atualize e exclua redirecionamentos da página da central de ajuda Notiondesk por meio da API REST. Importe em massa URLs antigas após uma migração.
Gerencie idiomas e tradução automática com a API NotiondeskAdicione ou remova idiomas da central de ajuda, defina o idioma padrão e ative ou desative a tradução automática por IA do Notiondesk por meio da API REST.
Atualize as configurações da central de ajuda com a API NotiondeskAtualize as configurações da central de ajuda do Notiondesk via API REST: indexação SEO, títulos de página, exportação de llms.txt e markdown, formulário de contato e registros de alterações.
Personalize a identidade visual e os temas da central de ajuda com a API NotiondeskAtualize a identidade visual da central de ajuda Notiondesk por meio da API REST: cores, fontes, layout, links de cabeçalho e rodapé, exibição de pesquisa e temas.
Gerencie as integrações da central de ajuda com a API NotiondeskConfigure o Google Analytics, Plausible, Umami, Intercom, Crisp, Help Scout e Google Tag Manager em sua central de ajuda Notiondesk por meio da API REST.
Obtenha análises da central de ajuda com a API NotiondeskExporte as análises do centro de ajuda Notiondesk por meio da API REST: visitantes, visualizações de artigos, principais pesquisas, pesquisas sem resultados e reações dos leitores.
Exporte o feedback do leitor com a API NotiondeskExporte o feedback do artigo Notiondesk via API REST: reações dos leitores, respostas de acompanhamento, mensagens e anexos, do mais recente para o mais antigo.
Automatize tarefas comuns da central de ajuda com a API NotiondeskExemplos da API Notiondesk: sincronizar do GitHub Actions, fazer backup de artigos em Markdown, enviar feedback para o Slack e relatar pesquisas sem resultados.