Passar para o conteúdo principal

Configuração de login dinâmico via API

Escrito por Wesley Camargo

O login dinâmico via API permite que usuários se autentiquem no WiFeed utilizando as credenciais do seu próprio sistema.
Este artigo orienta como ativar a permissão, criar o tipo de cadastro e configurar a integração da sua API com o WiFeed.
​
​Pré-requisitos para configuração:

  1. Uma API funcional, acessível publicamente e disponibilizada por meio de uma URL HTTPS válida.

  2. Acesso à plataforma WiFeed: system.wifeed.com.br;

  3. Um usuário de teste (e-mail e senha) do seu sistema, para validar a integração;
    ​

Etapa 1 - Ativação de permissão na conta

Para utilização do login dinâmico via API é necessária a ativação de uma permissão específica na conta, entre em contato com a equipe de suporte do WiFeed solicitando a ativação dessa permissão.

Etapa 2 - Criar o tipo de cadastro

Já com a permissão ativa em sua conta, realize o login e crie um novo tipo de cadastro do tipo "login dinâmico" acessando o menu lateral localizado no lado esquerdo da tela.
​


Preencha os campos conforme solicitado:
​

  • Selecione o tipo de formulário “Login dinâmico”.

  • Clique em "Avançar"

  • Vincule os locais onde esse tipo de login será aplicado.
    ​



    Etapa 3 - Configurar a API do cliente com o WiFeed


    Na aba "Requisição" realize a configuração da sua API.
    ​

  • Escolha o método HTTP (POST, GET ou PUT);
    (O método vai depender de como está configurada sua API)
    ​

    ​

  • Informar a URL completa do endpoint de sua API;
    ​


    Por motivos de segurança, o endpoint deve utilizar obrigatoriamente o protocolo HTTPS (https://). URLs utilizando HTTP ou outros protocolos não são aceitas em novas configurações ou alterações de configurações existentes.


    Além disso, o endpoint deve estar publicamente acessível e possuir um endereço válido e resolvível. Endereços internos ou privados, como localhost, 127.0.0.1, 192.168.x.x, 10.x.x.x e outros endereços de rede interna, não são permitidos.
    ​

⚠️ Importante: configurações de Login Dinâmico que já estavam salvas e funcionando anteriormente com HTTP continuam operando normalmente. A exigência de HTTPS é aplicada ao criar ou alterar uma configuração.

Ao utilizar a opção “Enviar teste”, a configuração é salva antes da execução do teste. Por isso, uma configuração antiga que ainda utilize HTTP precisará ser atualizada para HTTPS antes de ser testada novamente pela plataforma.
​

❔Como adequar uma integração existente?

Caso sua API esteja atualmente disponível apenas via HTTP, será necessário disponibilizá-la por HTTPS antes de criar ou alterar a configuração no WiFeed.

Uma possibilidade é utilizar um proxy reverso, como Nginx, na frente da aplicação e configurar um certificado HTTPS. Outra alternativa é utilizar um domínio com serviço de proxy, como o Cloudflare, para disponibilizar o endpoint por HTTPS.

  • Adicione headers, se a API exigir. O Header é opcional, depende se existe na API;
    ​

  • Insira os valores conforme a API solicitar;
    ​Exemplo:

  1. Chave: wifeed-chave

  2. Valor: 6b2c50fa03d834e30a1b0ad2a3bce6
    ​


    3.1 - Definir parâmetros enviados (Param ou BODY)

  • Caso sua API espere dados via Param (query string) ou BODY (payload).
    ​

  • Ative os campos do WiFeed que correspondem ao que sua API exige:

  1. Exemplo: se a API pede login e password, ative os campos equivalentes no WiFeed (como E-mail e Senha);

  2. É possível criar novos campos (Passo 3.3);

  3. Os campos que não forem utilizados podem permanecer desativados.

Para cada campo ativo, insira:

  1. Nome do campo: É o nome exato esperado pela API do cliente, exemplo:
    - Email
    - Senha
    ​

  2. Insira um exemplo: Deve ser um dado real do seu banco de dados para realizar o teste de integração bem sucedida, exemplo:
    - lucas.a
    - p@ssword123
    ​

  3. Marque o campo-chave (ícone de chave);
    Esse campo marcado como chave será o identificador principal do usuário dentro do WiFeed. (Será feita atualização e esse campo será o identificador em Conexões).
    ​


    ​

  4. Clique em "Enviar teste" para verificar se a integração está funcionando.
    ​


    ​Se o teste falhar, revise:

    1. O método utilizado (POST/GET/PUT);

    2. A URL configurada, verificando se utiliza HTTPS, se o domínio é válido e se o endpoint está publicamente acessível.

    3. A chave e valor configurado no Header (se houver);

    4. A configuração do tipo de envio dos dados, se está como PARAM (enviando como parâmetros da url) ou como BODY (enviando os dados no payload da requisição);

    5. No campo “nome do campo” verifique se a escrita do atributo está de acordo com o esperado pela API;

    6. Verifique se os dados preenchidos em “insira um exemplo” estão corretos e são válidos.
      ​

3.2 - Mapeamento de Retorno (opcional)

Se sua API retornar dados do usuário e você desejar salvá-los na plataforma do WiFeed, marque a opção "Salvar dados de retorno no WiFeed"
​


Ative os campos de retorno do usuário conforme sua API e salve a configuração.
​

3.3 - Criar novos campos em Param/Body e Retorno (se necessário)

  1. Clique na opção "Adicionar"
    ​


    ​

  2. Selecione o tipo de campo (de acordo com sua API);
    ​

  • Preencha o nome do campo;

  • Preencha a legenda do campo (como irá aparecer no captive portal);

  • Defina o tipo de máscara;

  • Seleciona a opção "Criar"
    ​


    Siga os passos do item 3.1 para definir os parâmetros enviados, incluindo os novos.

Finalizada a configuração, nas próximas conexões de usuário em sua rede com captive já será apresentado o botão referente ao login dinâmico.
​
Em caso de dúvidas entre em contato com nossas equipes de suporte.

Respondeu à sua pergunta?

Artigos relacionados