Manual de integração Unifi Controller - Versões 6.2.26 / 7.3.83/ 7.4.15 / 8.3.32
⚠️ ATENÇÃO ⚠️
Certifique-se que você atende todos os itens abaixo antes de iniciar.
👉 Acesso Plataforma do WiFeed system.wifeed.com.br;👉 Você está utilizando o manual correto em relação a versão da controladora em uso, neste caso a versão acima da 7.4.15 para novo layout UniFi;👉 Você está utilizando o manual correto em relação a versão da controladora em uso, neste caso a versão 6.2.26 até 7.3.83 para layout legacy UniFi;👉 Você possui uma controladora em funcionamento sem intermitência (sempre disponível e online);👉 O aparelho está adotado e funcional dentro da controladora;👉 O aparelho (AP/rádio) está com uma versão acima da 5.43.36;
|
⚠️Utilize as informações deste manual, este manual estará sempre atualizado, o vídeo servirá como apoio ⚠️
Estou pronto! Inicie aqui sua configuração ✅
Introdução
O WiFeed possibilita que os clientes que acessarem os pontos de acesso de determinada rede Wi-Fi passem por um processo de liberação antes de terem acesso à Internet. Esse processo irá identificar o cliente através de um cadastro e poderá apresentar um anúncio, propaganda ou questionamento antes da liberação do acesso. O conjunto de telas que o cliente irá visualizar referente a pesquisas e marketing é chamado de Campanha. Então, em resumo, o cliente ao conectar em um Wi-Fi com o WiFeed configurado, deverá passar pelos seguintes passos:
Cadastro no WiFeed;
Aceite dos Termos de Uso;
Execução da Campanha (se habilitada);
Liberação do acesso.
Este tutorial irá mostrar como realizar a configuração da solução de captive portal do WiFeed no Unifi Controller, a controladora do Unifi da Ubiquiti Networks. Essa configuração deverá ser realizada em 7 etapas:
Configuração do acesso externo à controladora que permite a comunicação entre plataforma e a controladora;
Configuração da rede onde os clientes irão acessar o captive portal;
Configuração do Wi-Fi onde será definido o SSID e habilitado o Guest Portal;
Configuração do portal que direciona os clientes para o captive portal externo do WiFeed após conectarem no ponto de acesso;
Liberação dos domínios utilizados pela solução, que permite que os clientes ainda não liberados possam alcançar os serviços do WiFeed que estão na Internet;
Configuração controladora UniFi mais antiga, controladora com versão 6.2.26 até 7.3.83;
Registro dos Pontos de Acesso na plataforma WiFeed, que autorizam os pontos de acesso a fazerem parte da solução e mostram para o WiFeed de onde estão vindo os acessos;
E, por fim, o teste da solução, que descreve o passo a passo de um cliente ao conectar em um ponto de acesso configurado.
⚠️ IMPORTANTE: Antes de seguir as etapas deste tutorial, você deverá ter acesso à plataforma WiFeed. A plataforma se encontra disponível no seguinte endereço: |
Resumo das configurações
Liberação para comunicação WiFeed e Controladora;
Criação do usuário dentro da controladora;
Configuração do Hotspot;
Links de liberação (Walled Garden);
Entre na plataforma do WiFeed https://system.wifeed.com.br/locais;
Configurações > locais > Registrar um grupo > Adicionar Local >
Adicionar Aparelho do tipo Unifi e inserir o Mac address da WAN no campo chave do aparelho;
Para testar você deve ser atentar somente ao teste na ponta, com um dispositivo celular ou notebook, você deve se conectar ao Wi-Fi e verificar a aplicação na tela.
Configuração completa
Etapa 1 - Configuração do acesso externo à controladora
Primeiramente, é necessário configurar um acesso externo para que a plataforma do WiFeed consiga fazer a liberação dos clientes através da API do Unifi. Para configurar esse acesso é necessário criar um novo usuário na controladora e informar para a plataforma WiFeed quais serão os dados de acesso.
1.1. Entendendo o cenário
Basicamente, quando um cliente acessar o Wi-Fi, ele irá passar pelo processo de cadastro, aceitação dos termos de uso, impactação da campanha (anúncio ou pesquisa) e, por fim, a liberação para acesso à Internet. Essa etapa é essencial para que o cliente que viu o anúncio consiga ter acesso à Internet. Para isso, os servidores do WiFeed precisam se comunicar diretamente com a controladora. A figura a seguir ilustra esse processo de forma simplificada:
Processo simplificado do captive portal
1 - O cliente se conecta ao Ponto de Acesso;
2 - O Ponto de Acesso verifica se existe algum captive portal configurado na controladora. Perceba aqui que é necessário que a controladora sempre esteja ativa;
3 - A controladora informa para o Ponto de Acesso para qual endereço o cliente deve ser direcionado;
4 - O cliente inicia a comunicação com o Portal WiFeed fazendo o cadastro e executando a campanha de marketing;
5 e 6 - No final do processo de campanha o WiFeed envia um comando para a controladora para liberar o cliente, porém, caso a controladora não esteja com um IP alcançável (público), é necessária uma configuração de NAT (redirecionamento de porta) no Roteador de Borda da rede onde a controladora está instalada;
7 - A controladora avisa o Ponto de Acesso que o cliente foi liberado;
8 - O cliente pode acessar a Internet.
1.2. Criando um novo usuário na controladora
Para acessar esta opção será necessário mudar o layout da controladora para Legacy:
Entre no menu de configurações, clique na opção System e clique no botão Advanced > Show More e selecione a opção Legacy
Ao selecionar a opção Legacy clique em Deactivate
Ao clicar em Deactivate automaticamente será direcionado para o Legacy e assim prosseguir com as configurações de usuário abaixo:
Entre no menu de configurações, clique no item Admins e clique no botão Add New Admin.
Na tela de criação de admin, preencha as informações como abaixo:
Invite to Controller: selecione a opção Manually set and share the password;
Name: escolha um nome de usuário de sua preferência;
Password: escolha uma senha de sua preferência e desabilite a opção Require the user to change their password;
E-mail: pode ser informado qualquer e-mail, mas normalmente utilizamos o e-mail [email protected]
Role: selecione a opção Super Administrator;
Site Permissions: desabilite a opção Allow devices adoption;
Global Permissions: desabilite todas as opções, inclusive a Show pending devices;
Exemplo da configuração para criar um novo usuário
IMPORTANTE: É obrigatório definir o nível de permissão (Role) como Super Administrator.
Observação: Após finalizar a configuração do usuário será necessário voltar a controladora para o novo Layout:
Entre no menu de configurações, clique no item User Interface e clique no botão New User Interface
Salve as configurações clicando em Apply changes e vá para o próximo passo.
1.3. Liberando o acesso externo à controladora
Conforme mencionado anteriormente, para que a plataforma consiga liberar os clientes, é preciso que a mesma consiga se comunicar com a controladora. Ou seja, é necessário que a controladora fique exposta através de um IP público, ou você pode utilizar um Dynamic DNS (no-ip, ddns...) para vincular seu IP a um domínio.
Porém, ao expor a controladora, é aberta uma porta para possíveis ataques, diminuindo a segurança da rede. Para restringir esse risco, recomenda-se limitar o acesso à controladora apenas aos IPs utilizados pela plataforma WiFeed.
Faixas de IP da plataforma WiFeed:
20.206.88.5/32
20.226.59.142/32
20.206.107.132/32
144.22.239.52/32
167.234.243.166/32
167.234.237.18/32
144.22.198.172/32
146.235.50.104/32
129.148.27.103/32
167.234.238.167/32
164.152.63.13/32
167.234.232.193/32
152.67.48.34/32
FQDN:
bigbox.wifeed.com.br
api.wifeed.com.br
hs.portalwifeed.com.br
Existem 2 cenários possíveis de configuração nessa etapa:
Controladora com IP Público: caso a controladora esteja configurada em um servidor com IP público, é necessário apenas liberar o acesso à controladora no firewall da rede;
Controladora atrás de um NAT: é preciso criar um redirecionamento de porta para a porta 8443 da controladora, também restringindo a origem para a faixa de IP do WiFeed.
Essa liberação de acesso é um pré-requisito para o próximo passo, que será registrar as informações de acesso na plataforma WiFeed.
1.4. Registrando a controladora na plataforma WiFeed
Entre na plataforma do WiFeed https://system.wifeed.com.br;
localize no menu a esquerda Configurações;
Clique em Configurações e em seguida locais https://system.wifeed.com.br/locais;
Telas de Configurações
Na tela de gerenciamento de Locais clique no botão Registro Controladora. Preencha as informações com os dados do usuário criado anteriormente na controladora.
Informações para registro da controladora
Login: Login criado em sua controladora para o WiFeed, se não possuir, crie uma conta como Super Administrador e utilize aqui;
Senha: Senha criada em sua controladora para o WiFeed, se não possuir, crie uma conta como Super Administrador e utilize aqui;
Domínio: IP público que chega à controladora ou domínio;
Porta: Porta da controladora, porta padrão 8443, se tiver dúvida consulte se a sua porta não foi alterada na controladora;
Tela de registro da controladora
⚠️ Atenção, não copie os dados da imagem acima, eles são apenas para exemplificar.
Para testar se os parâmetros de acesso foram informados corretamente, clique no botão Testar. Esse botão irá enviar um comando para a controladora, verificando se existe comunicação entre a controladora e a plataforma WiFeed.
Caso esteja tudo configurado corretamente, após clicar no botão Testar, deverá aparecer no canto superior direito a seguinte mensagem:
Mensagem de sucesso do Teste de comunicação entre a controladora e a plataforma
⚠️ Observação: Caso você tenha dois IP'S públicos ou domínios direcionando para a controladora é possível cadastrar o segundo como Failover:
Após o cadastro é possível realizar o teste de comunicação do Failover no botão "Testar Failover".
Etapa 2 - Configuração da Network
Nesta versão da controladora podemos utilizar o Network Default ou criar uma V-LAN.
Caso queira utilizar V-LAN cliquei no menu de configurações, clique no item Networks e clique em Virtual Networks.
Na tela de configuração da Network será solicitado o nome da rede e a VLAN ID
Etapa 3 - Configuração da Wireless Network
No menu de configurações, clique no item WiFi e, posteriormente, no botão Create New. Caso você já possua uma rede Wi-Fi configurada, poderá alterar as configurações da mesma.
Na tela de configuração de WiFi:
Defina um Name de sua preferência (Nome do SSID da rede);
Defina o Network com o que foi criado ou utilizar o Default
Como a rede será aberta ao público, no campo Advanced, selecione a opção Manual;
Habilite a opção Hotspot Portal
E, por fim, em Security Protocol selecione a opção Open (Desta forma a rede ficará aberta sem senha)
A imagem abaixo ilustra como ficarão as configurações:
Após finalizar pode clicar em Apply Changes.
O restante das configurações não importam para o funcionamento do captive portal e podem ser definidas de acordo com sua preferência.
Salve as configurações e vá para a próxima etapa.
Etapa 4 - Configuração do Captive Portal
No menu de configurações, clique no item Insights, Hotspot e por último na opção Landing Page
Clique na opção Authentication, em External Portal Server clique em Edit e preencha com o IP 20.206.107.132;
Clique na opção Settings, em Landing Page Settings marque apenas as opções: Show Landing Page, Domain e preencha com o endereço abaixo:
bigbox.wifeed.com.br |
Etapa 5 - Liberação dos domínios de pré-liberação
Nesta etapa é necessário liberar alguns domínios e subdomínios que o captive portal irá utilizar antes de liberar o cliente. Caso esses domínios não sejam desbloqueados, haverá problemas no login via Facebook e também no acesso ao próprio captive portal do WiFeed.
Para realizar essa configuração, ainda na tela de configurações do Hotspot Manager, na opção Settings clique em Authorization Access , informe os domínios listados abaixo:
⚠️Observação: O WiFeed funcionará com suas próprias URLs liberadas. No entanto, para que algumas funcionalidades adicionais funcionem corretamente, é necessário liberar também as URLs específicas desses serviços. |
URLs para liberação do Facebook
|
URLs para liberação do Linkedin
|
URLs para liberação do X (Twitter)
|
URLs para liberação do Yotube
Observações: caso seu equipamento não aceitar * (asterisco) você pode remove-lo! |
URLs para liberação do Google Workspace
|
URLs para liberação do Active Directory (Azure)
Observações: caso seu equipamento não aceitar * (asterisco) você pode remove-lo! |
A imagem abaixo ilustra como deverá ficar a configuração:
Etapa 6 - Caso você tenha uma controladora um pouco mais antiga, irá seguir essas configurações. (Versão 6.2.26 até 7.3.83(
Caso você tenha uma controladora um pouco mais antiga, irá seguir essas configurações:
6.1 Criando um novo usuário na controladora
Entre no menu de configurações, clique no item Admins e clique no botão Add New Admin.
Na tela de criação de admin, preencha as informações como abaixo:
Invite to Controller: selecione a opção Manually set and share the password;
Name: escolha um nome de usuário de sua preferência;
Password: escolha uma senha de sua preferência e desabilite a opção Require the user to change their password;
E-mail: pode ser informado qualquer e-mail, mas normalmente utilizamos o e-mail [email protected]
Role: selecione a opção Super Administrator;
Salve as configurações e vá para o próximo passo.
6.2 Configuração da Network
No menu de configurações, clique no item Networks e posteriormente no botão Create New Network. Caso você já possua uma rede configurada, poderá alterar as configurações da mesma ou criar uma nova.
Caso utilizar VLAN nos Ap's, terá que criar a VLAN com a opção VLAN Only e informar o ID
6.3 Configuração da Wireless Network
No menu de configurações, clique no item Wireless Networks e, posteriormente, no botão Create New Wireless Network. Caso você já possua uma rede Wi-Fi configurada, poderá alterar as configurações da mesma.
Na tela de configuração de Wireless Network:
Defina um SSID de sua preferência;
Habilite a opção Enable this wireless network;
Como a rede será aberta ao público, no campo Security, selecione a opção Open;
Habilite a opção Apply guest policies (captive portal, guest authentication, access);
E, por fim, no campo Network, selecione qual rede deverá ser utilizada (rede configurada na Etapa 1).
A imagem abaixo ilustra como ficarão as configurações:
O restante das configurações não importam para o funcionamento do captive portal e podem ser definidas de acordo com sua preferência.
Salve as configurações e vá para a próxima etapa.
6.4 Configuração do Captive Portal
No menu de configurações, clique no item Guest Control e defina as seguintes configurações na seção de Guest Control:
Enable Guest Portal: deixe ativado;
Authentication: selecione a opção External portal server;
Custom Portal - IPv4 Address: essa opção não é relevante para a configuração, mas como é um campo obrigatório do formulário, podemos informar o IP do servidor WiFeed que irá tratar as requisições vindas do captive portal, que é o IP 20.206.107.132;
Redirection: é um conjunto de parâmetros que irão definir para onde e como os clientes serão direcionados após se conectarem ao Wi-Fi.
Desabilite a opção Use Secure Portal
Selecione a opção Redirect using hostname e informe o seguinte endereço no campo:
bigbox.wifeed.com.br |
A imagem abaixo ilustra como ficarão as configurações:
Salve as configurações e vá para a próxima etapa.
6.5 Liberação dos domínios de pré-liberação
Nesta etapa é necessário liberar alguns domínios e subdomínios que o captive portal irá utilizar antes de liberar o cliente. Caso esses domínios não sejam desbloqueados, haverá problemas no login via Facebook e também no acesso ao próprio captive portal do WiFeed.
Para realizar essa configuração, ainda na tela de configurações do Guest Control, na seção Access Control, informe os domínios listados abaixo:
⚠️Observação: O WiFeed funcionará com suas próprias URLs liberadas. No entanto, para que algumas funcionalidades adicionais funcionem corretamente, é necessário liberar também as URLs específicas desses serviços. |
URLs para liberação do Facebook
|
URLs para liberação do Linkedin
|
URLs para liberação do X (Twitter)
|
URLs para liberação do Yotube
Observações: caso seu equipamento não aceitar * (asterisco) você pode remove-lo! |
URLs para liberação do Google Workspace
|
URLs para liberação do Active Directory (Azure)
Observações: caso seu equipamento não aceitar * (asterisco) você pode remove-lo! |
A imagem abaixo ilustra como deverá ficar a configuração:
Etapa 7 - Configuração dos pontos de acesso na plataforma WiFeed
Na tela de gerenciamento de Locais, mostrada no Passo 1.4 da Etapa 6, será possível criar Locais, Grupos de Locais, Pontos de Acesso e Grupos de Pontos de Acesso, sendo que um Ponto de Acesso deverá sempre estar dentro de um Local. Já os grupos são uma forma de organizar todos esses registros.
7.1. Cadastro do Local
Um local é um ambiente físico onde os pontos de acesso serão instalados. Ele pode ser um hotel, um supermercado ou um restaurante por exemplo. Ao cadastrar um local podemos definir um nome para identificá-lo dentro da plataforma e definir o tempo de conexão, que será o tempo que o usuário poderá utilizar a internet após a liberação no captive portal, além disso deve-se informar os dados referentes ao endereço.
Para criar um local:
Entre na plataforma do WiFeed https://system.wifeed.com.br;
localize no menu a esquerda Configurações;
Clique em Configurações e em seguida locais https://system.wifeed.com.br/locais;
4. Clique no botão Registrar Local na parte superior da tela.
Uma nova janela será aberta permitindo definirmos algumas informações sobre o local.
Tela de cadastro de Local
Preencha as informações, salve o registro e ative o local na listagem.
Tempo de conexão: É o tempo em que o usuário ficará conectado até encerrar o tempo programado, ao final deste tempo a conexão é interrompida e inicia-se um novo ciclo;
Tempo para próximo acesso: É o tempo em que o usuário ficará bloqueado até poder iniciar um novo acesso, utilize somente em casos que deseja bloquear os usuários por um tempo.
Fuso horário: Utilizado somente em casos onde o fuso é diferente;
Controladora (Funcionalidade exclusiva Unifi): Selecione a controladora na qual esta vinculado os APs, o sistema permite o uso de mais de uma controladora;
Somente maiores de 18: Bloqueio de rede para menores de 18 anos;
Salve o registro e Ative o local na listagem.
7.2. Cadastro do Ponto de Acesso
O ponto de acesso é o equipamento que irá permitir os clientes acessarem o captive portal e visualizarem os anúncios veiculados para, posteriormente, terem acesso à Internet. Mas antes de realizar o teste de acesso é necessário registrar os pontos de acesso na plataforma. Ao registrar um ponto de acesso você está informando à plataforma WiFeed que este equipamento poderá realizar requisições. Então, é importante registrar todos os pontos de acessos instalados.
Para cadastrar um ponto de acesso, ou Aparelho, como é chamado dentro da plataforma WiFeed, vá até um registro de Local e clique no ícone de soma ( + ) e depois na opção Novo Aparelho, como mostrado na imagem abaixo.
Na janela do cadastro defina um nome para o Aparelho, selecione Unifi API (Ubiquiti) no campo Tipo de Aparelho e informe no campo Chave do Aparelho o MAC Address do Ponto de Acesso.
IMPORTANTE: Verifique se o MAC Address informado é realmente o MAC Address do Ponto de Acesso. É possível encontrar essa informação tanto no próprio equipamento, quanto na lista de Devices do Unifi Controller. Lembrando que o MAC Address deve estar no formato 00:00:00:00:00:00.
Preencha as informações e salve o registro.
Etapa 8 - Testando a solução
Com a controladora configurada e os pontos de acesso registrados na plataforma é hora de conectar no Wi-Fi e ver se está tudo funcionando corretamente.
Ao conectar, o ponto de acesso deverá direcionar você para o captive portal, apresentando a seguinte tela caso você não seja um usuário cadastrado:
Caso você não seja um usuário cadastrado ao se conectar ao ponto de acesso você deverá ser direcionado para o captive portal, apresentando tela de cadastrado ou tela de login, ao final do cadastro e do aceite do termo de uso você irá ser redirecionado para a sua primeira campanha.
Caso você seja um usuário cadastrado, você irá ser redirecionado para a sua primeira campanha.
Pontos importantes:
O cadastro é único na rede do WiFeed, independente do local;
A tela de cadastro é apresentada somente no primeiro acesso;
As campanhas aparecerão apenas após o cadastro;
Todos os acessos possuem um tempo de conexão, ele é definido em locais, clique aqui e veja como editar;
As telas de cadastro são personalizadas, clique aqui e veja como personalizar;
Caso queira visualizar o tempo restante de conexão, poderá ir até o menu Conexões, na plataforma WiFeed, para ver a lista de usuários liberados pela plataforma.
Principais Erros
A seguir são apresentados alguns erros que podem ocorrer durante o processo de instalação.
ERRO 1 - Code: 200 - Aparelho desativado no WiFeed
Registro de unidade AP não encontrado ou desativado
Possíveis Causas:
O Aparelho Intelbras não foi cadastrado no WiFeed (nome e mac address);
O local onde o aparelho está cadastrado no WiFeed está desativado;
Resolução: Ativar o local ou se o local não existe mais, refazer o processo de configuração;
ERRO 2 - Code: SD1 - Possivel bloqueio de Firewall ou falha de comunicação
O captive portal entra em loop e o cliente não é liberado, apresenta-se no canto inferior esquerdo o código SD1. Pode existir alguma instabilidade da rede no momento da liberação ou bloqueios de firewall.
Possíveis Causas:
Bloqueio do IP do Radius por um firewall na rede;
Bloqueio das portas 7564 ou 4657 por um firewall na rede.
Resolução: Verificar se existe algum serviço de Radius bloqueando 7564 ou 4657 por um firewall na rede.
ERRO 3 - Tela branca - Falha de comunicação
O captive portal entra em uma tela branca e não avança no processo de liberação.
Possíveis Causas:
Falha de comunicação entre controladora e WiFeed;
AP com problemas de comunicação;
Resolução: Verificar se existe alguma falha de comunicação na rede, sem internet ou algo relacionado a rede ou dispositivo que provê a internet ou DHCP.
Verificar no teste do WiFeed a comunicação entre Controladora e WiFeed.
Considerações Finais
Como foi visto, a configuração da solução WiFeed é realizada tanto na plataforma, quanto na rede do estabelecimento que irá disponibilizar Wi-Fi para seus clientes.
E é normal ocorrer alguns problemas até deixar a solução funcionando corretamente. Isso porque esta solução na verdade depende de outras soluções. Depende do ponto de acesso ser integrado, depende do smartphone permitir a identificação de um captive portal em uma rede pública, depende da rede do estabelecimento estar corretamente configurada, entre outros fatores que podem interferir na solução, como firewalls e proxies.
Mas caso você tenha problemas para realizar esta configuração, entre em contato com nossa central de atendimento que iremos ajudá-lo.