Módulo de chatbot Drupal

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.

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

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/.

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.