Pular para o conteúdo principal

Módulo de chatbot Drupal

O módulo inicia desativado. O endpoint API é integrado: mudar URL do loader não o muda. Em auto, o idioma da página precede o navegador; fixed usa default e o override exige permissão. Rotas administrativas não são controlo de privacidade para todo frontend: exclua checkout/conta quando necessário e use apenas um loader.

Use o módulo Drupal oficial do ChattyBox quando quiser uma instalação gerenciada pelo Composer para um site Drupal 10 ou Drupal 11. Ele carrega o widget hospedado em rotas HTML públicas e mantém o endpoint de produção configurado automaticamente. Este guia aborda a configuração operacional. A página do módulo de chatbot IA para Drupal resume o produto e o fluxo de avaliação.

Antes de instalar

Conclua primeiro o fluxo Primeiros passos: conecte o URL público do Drupal, revise as páginas indexadas e verifique respostas representativas em Test Chat. Em seguida, crie uma chave pública segura para o navegador em Public Keys e copie-a da aba Embed do projeto.

Instalação com Composer

O módulo é atualmente distribuído como um pacote identificado por tag no repositório público do GitHub. Ainda não está listado no Drupal.org nem no Packagist, pelo que o Composer precisa da declaração do repositório VCS abaixo antes de composer require o poder resolver.

Adicione o repositório público do GitHub ao composer.json raiz do projeto Drupal que o utiliza:

{
"repositories": {
"chattybox-drupal": {
"type": "vcs",
"url": "https://github.com/OpenStaticFish/chattybox-drupal.git"
}
}
}

Se o projeto já tiver uma seção repositories, mescle a entrada chattybox-drupal nela. Depois, instale o módulo marcado:

composer require openstaticfish/chattybox-drupal:^0.1

O pacote é declarado como drupal-module e requer Drupal ^10 || ^11. Os caminhos padrão do instalador Composer do Drupal colocam o módulo em web/modules/contrib/.

Consulte o código-fonte público do módulo Drupal e as alterações identificadas por tag antes de atualizar. As atualizações do Drupal.org geridas pelo diretório ainda não estão disponíveis.

Para testar a branch de desenvolvimento atual:

composer require openstaticfish/chattybox-drupal:dev-main

Ativar e configurar

  1. Ative o ChattyBox em Extend ou execute drush en chattybox.
  2. Abra Configuration > Web services > ChattyBox.
  3. Cole somente a chave de API pública do widget da aba Embed do projeto.
  4. Mantenha o URL do script do widget hospedado, a menos que o ChattyBox tenha fornecido um URL de loader de pré-visualização ou auto-hospedado.
  5. Deixe a substituição de idioma em branco para seguir o idioma da página ou do navegador, ou insira um código de duas letras, como en, fr ou de.
  6. Ative o chatbot e salve a configuração.

O módulo não é carregado em rotas administrativas nem em respostas que não sejam HTML. Ele adiciona a chave pública, o endpoint de produção gerenciado, o idioma opcional e o loader do widget por meio da biblioteca declarada do Drupal e de drupalSettings.

Excluir rotas adicionais

O módulo ignora rotas administrativas automaticamente. Um módulo personalizado pode desativar o widget em outras rotas públicas usando hook_chattybox_load_widget_alter():

/**
* Implements hook_chattybox_load_widget_alter().
*/
function mymodule_chattybox_load_widget_alter(&$should_load, $config, $route_match) {
if ('commerce_checkout.form' === $route_match->getRouteName()) {
$should_load = FALSE;
}
}

Alternativa manual

Composer é o caminho de instalação recomendado. Se o seu deployment Drupal não puder usar Composer, copie o módulo para web/modules/custom/chattybox ou outro diretório de módulos personalizados, ative-o e configure-o em Configuration > Web services > ChattyBox.

Não cole uma credencial de gerenciamento no módulo. A chave de API pública do widget é destinada à marcação do frontend.

Verificação

Depois de configurar o módulo:

  • Abra uma página pública do Drupal em uma janela anônima.
  • Confirme que o launcher do widget aparece uma vez.
  • Faça uma pergunta real de visitante.
  • Verifique se a resposta inclui citações de fontes para páginas públicas do Drupal.
  • Verifique o console do navegador em busca de data-api-key, data-api-url ausentes ou erros de chave.

Continue com a checklist de lançamento antes de anunciar o chatbot.

Utilizamos ferramentas opcionais de análise e gestão de tags para compreender a utilização do site. Escolha se pretende permitir o Ahrefs Web Analytics, o PostHog e o Google Tag Manager. Ao desativar a análise, esta página será recarregada para que a alteração seja aplicada corretamente. A funcionalidade essencial do site e a monitorização de erros não são controladas por esta escolha. Leia a nossa política de privacidade.