---
title: Acesso Externo ao Chatbot
slug: acesso-externo-ao-chatbot
createdAt: 2020-09-03T11:38:19.000Z
---



::Image[]{src="https://api.archbee.com/api/presign/-NgzYlP2qbXPUTr19M7qj/6ZxzQ9VsV4SPsazPaKxLd_image.png" size="30" position="flex-start" showCaption="false"}

O Chatbot pode ser acessado por uma página de seu site, havendo algumas maneiras disto acontecer; Uma por meio da inicialização automática com parametrização na query string e outra com o controle da inicialização manual. O controle da inicialização manual permite também que seja parametrizada uma chave de API, que não irá trafegar na query string, dando mais segurança.

## Parametrização na query string

Para inicializar automaticamente através da query string, importe o script colocando obrigatoriamente o parâmetro “initialize=true” na query string (os outros parâmetros são opcionais), como no exemplo abaixo: 

```html
//Inicialização com parâmetros pela query string
    <script src="https://minhaempresa.clickcompliance.com/js-api/embedded-
    chatbot.js?initialize=true&hideButton=true&displayName=John%20Doe&email=
    john.doe%40clickcompliance.com"></script>

```

## Controle da inicialização manual

Também pode ser feita uma inicialização manual importando o script e realizando a chamada ao método initialize() separadamente:&#x20;

```html
//Importação apenas 
    <script src="https://minhaempresa.clickcompliance.com/js-api/embedded-
    chatbot.js"></script>

```

```html
//Inicialização separada
<script>
  clickcompliance.chatbot.initialize();
  // Ou com os parâmetros (opcional) 
  clickcompliance.chatbot.initialize({
      hideButton: true;
      displayName: "John Doe";
      email: "john.doe@clickcompliance.com"
  });
</script>
      
```

### Chave de API

Para configurar uma chave de API e dar mais segurança ao uso do chatbot externamente, o gestor do módulo do bot deve antes gera-la através do menu incorporação:

![](https://api.archbee.com/api/optimize/-NgzYlP2qbXPUTr19M7qj/UsN63nTurfJM_5BMacvTH_image.png)

A chave gerada deve ser utilizada no seu código, como no exemplo abaixo:

```html
<script>
  clickcompliance.chatbot.initialize({
      apiKey: '**********************************';  
      hideButton: true;
      displayName: "John Doe";
      email: "john.doe@clickcompliance.com"
  });
</script>

```

### Descrição dos parâmetros:&#x20;

| Parâmetro    | Descrição                                                                                                                                                                                                                                                                                                                                                                                          |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| apiKey       | Valor da chave gerada no sistema (Opcional)                                                                                                                                                                                                                                                                                                                                                        |
| hideButton   | Esconde o botão padrão do chatbot (Opcional)                                                                                                                                                                                                                                                                                                                                                       |
| displayName  | Nome que será usado pelo chatbot para conversar com o usuário e será registrado no log do bot (Opcional)                                                                                                                                                                                                                                                                                           |
| email        | Será registrado no log do bot. (Opcional)<br /><font color="#eb144c">Importante\: Caso não seja fornecido, os usuários do chat não serão
identificados e a sessão de interação será considerada anônima. Neste caso,
indicadores futuros que dependam de dados dos usuários, não poderão ser
extraídos. Além disto, um usuário anônimo não poderá enviar dúvidas para o time de analistas. </font> |



### Métodos de controle do bot:&#x20;

```html
<script>
  // Exibe a janela do chatbot
  clickcompliance.chatbot.show();
  // Esconde a janela do chatbot
  clickcompliance.chatbot.hide();
  // Altera a visibilidade da janela do chatbot
  clickcompliance.chatbot.toggle();
</script>

```



## Um exemplo de utilização em seu site

(O exemplo abaixo utiliza a parametrização na query string)

```html
<!DOCTYPE html>
<html>
<head>
<title>Meu site</title>
</head>
<body>
<p>Compliance Chatbot</p>
<button clickcompliance-chatbot-toggle> Iniciar chat
</button>
<script src="https://minhaempresa.clickcompliance.com/js-api/embedded-
chatbot.js?initialize=true&hideButton=true&displayName=John%20Doe&email=
john.doe%40clickcompliance.com"></script>
</body>
</html>

```