Gerencie as integrações da central de ajuda com a API Notiondesk

A API Notiondesk permite listar, configurar e desativar as integrações de terceiros da sua central de ajuda: provedores de análise, chat ao vivo e gerenciadores de tags. Use-a para implementar a mesma configuração de análise ou chat em várias centrais de ajuda com um único script.

Configurar e desativar provedores requer um plano que inclua integrações.

Cada provedor carrega um script de terceiros em todas as páginas da sua central de ajuda. Um contêiner do Google Tag Manager executa tudo o que seu proprietário publica, e o Plausible ou o Umami decidem de onde o script de análise será carregado. É por isso que alterar as integrações exige controle de escopo. Atribua uma chave apenas às integrações em que você confia.proxy_urladminadmin

Prestadores de serviços apoiados

Cada valor é uma sequência de até 255 caracteres. Nenhum deles é secreto: cada um é um identificador que o script do provedor precisa na página. Notiondesk verifica o formato, mas não o próprio ID com o provedor.

Liste suas integrações

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

{
  "object": "list",
  "data": [
    {
      "type": "plausible-analytics",
      "settings": {"domain": "help.example.com", "proxy_url": null},
      "enabled": true
    },
    {
      "type": "crisp",
      "settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
      "enabled": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

A lista inclui provedores que estão desativados, sem ordem específica, e sempre cabe em uma única resposta. Um provedor que nunca foi configurado está ausente.

Configurar um provedor

Envie os campos do provedor para o caminho correspondente. A rota responde com 200 OK na integração.

curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"domain": "help.example.com"}'

{
  "type": "plausible-analytics",
  "settings": {"domain": "help.example.com", "proxy_url": null},
  "enabled": true
}

• Uma atualização sempre ativa o provedor. Não existe o campo enabled: para desativar um provedor, use a rota disable.

• Um campo que você omite mantém seu valor armazenado. Para reativar um provedor configurado sem alterá-lo, envie {}.

• Para remover um proxy, envie "proxy_url": null.

• Cada atualização renova toda a central de ajuda, limpando as páginas em cache e reconstruindo cada página.

Observação: Um valor salvo antes da aplicação dos formatos atuais, como um ID do Google Analytics ou um valor que não seja válido, falhará na validação. Até que você envie um valor válido para esse campo, todas as atualizações desse provedor retornarão o código 400, inclusive.UA-proxy_urlhttpsvalidation_error{}

Desativar um provedor

A rota responde com 204 No Content e sua central de ajuda para de carregar o provedor. Suas configurações são mantidas, então a lista ainda o mostra com enabled: false, e {} enviado para sua rota de atualização o reativa.

Desativar um provedor que já está desativado, ou um que nunca foi configurado, também retorna 204 e não altera nada, portanto, tentar novamente é sempre seguro.

Erros

curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Consulte a seção sobre erros da API Handle Notiondesk, limites de taxa e novas tentativas para obter informações sobre o envelope do erro e os demais códigos.

Perguntas frequentes

O que vem a seguir?

• Obtenha análises da central de ajuda com a API Notiondesk

• Personalize a identidade visual e os temas da central de ajuda com a API Notiondesk

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