Obter CEPs

Sumário

1. Conceito

O plugin é um componente de software adicional que estende ou personaliza as funcionalidades de uma plataforma ou ferramenta. Com este plugin será possível buscar CEPs através da API ViaCep.

2. Parâmetros e Configurações

• Configuração Inicial:
  • Na tela de plugins, lcocalize a opção Obter Ceps;
  • Este plugin possui campos de entrada e saída padrão, portanto, não é necessário configurar nada manualmente;
  • Para utilizar o plugin, será necessário especificar somente o campo CEP, contendo os campos de saída:
    • CEP;
    • UF;
    • Cidade;
    • Bairro;
    • Rua;
    • Complemento;
    • DDD;
    • IBGE.
  • Pontos importantes: O campo de CEP a ser enviado deve conter o hífen (‘-’) para que a consulta seja realizada com sucesso.

3. Fluxo de Dados

• O usuário configura uma fonte de dados no plugin e a vincula a um campo do formulário, geralmente chamado CEP;
• O usuário informa o CEP desejado e inicia a consulta;
• Ao ser acionado, o plugin se conecta à API ViaCep e retorna o endereço correspondente.

4. Erros e Logs

Para verificar o funcionamento do plugin, acesse a sua tela e vá até a aba Histórico de Execução. Nessa seção, é possível consultar os retornos específicos do plugin.

5. Como Testar

• Testando pela Plataforma:
  • Para realizar um teste rápido pela Plataforma, acesse a tela do plugin Obter CEPs;
  • Em seguida, clique na opção Testar Plugin;

  

  • Clique no botão Testar Plugin (ícone);
  • Digite o CEP para localizar e clique em Executar.

  

  

• Testando pelo Postman:
  • Um exemplo simples é acionar o plugin utilizando a primitiva invoke:

  

  • Para este tipo de teste será necessário passar o header Authorization com o token do usuário logado na Plataforma;
  • No payload da requisição é preciso informar o ID da configuração do plugin e o ID do plugin;
  • Os campos enviados ao plugin devem ser incluídos no objeto inputData.

  Exemplo de body enviado na primitiva invoke:

  

6. Montando um Processo utilizando o Plugin

Para montar um processo utilizando o plugin Obter CEPs como fonte de dados, é necessário, como primeiro passo, criar uma fonte de dados. Com isso, basta acessar a tela de fonte de dados, e na aba plugin, pesquisar por Obter CEPs. Localizado o plugin, basta clicar em Configurar e clicar em Salvar.

Com a fonte da dados configurada, é possível criar um processo:

E posteriormente, configurar um formulário ECM

No campo CEP, criaremos uma consulta utilizando uma fonte de dados — especificamente, a que acabamos de configurar.

Por fim, basta criar um fluxo simples para que ele possa ser utilizado.

7. Limitações

Como o plugin depende de uma API externa, qualquer instabilidade na API ViaCep poderá impactar diretamente o funcionamento do plugin.