Sticky

Requisições HTTP para consultar CEP

  • 1 December 2023
  • 10 replies
  • 321 views

Userlevel 3
Badge

Boa tarde pessoal, venho compartilhar com vocês como realizar a configuração das automações de HTTP para realizar consultas de CEP. 

 

CONFIGURANDO A REQUISIÇÃO 

Para gatilho, utilizamos o que fizer mais sentido para seu processo. Como ação, iremos selecionar a opção “Faça uma requisição HTTP” e iremos realizar a seguinte configuração:

Requisição para consulta de CEP
  • Method: GET
  • URLhttps://viacep.com.br/ws/[CAMPO_DINAMICO_CEP]/json/ (utilize um campo numérico pois a informação deve ir apenas números)
  • Authentication: No auth
  • Header/Value: Não precisa preencher

  • Tipo de conteúdo de requisição: JSON

  • Request body: Não precisa preencher

  • Response: Não precisa preencher (apenas caso deseje verificar o retorno da chamada. É uma boa pratica para verificar erros)

  •  

    JSON schema: Este campo será utilizado de base para dizer como é o retorno da chamada HTTP e será utilizado na configuração posterior da automação, sendo necessário para funcionar corretamente

    •     {
      "cep": "01001-000",
      "logradouro": "Praça da Sé",
      "complemento": "lado ímpar",
      "bairro": "Sé",
      "localidade": "São Paulo",
      "uf": "SP",
      "ibge": "3550308",
      "gia": "1004",
      "ddd": "11",
      "siafi": "7107"
      }

Após isso basta salvar e nomear sua automação como desejar. 

  • Caso tenha dúvidas sobre o endpoint utilizado, referente a volume de requisições acesse https://viacep.com.br/ 
  • Caso seu processo tenha um grande volume de consultas, existem APIs de consulta pagas que não irão lhe limitar, sendo necessário ajustar de acordo com a documentação da plataforma utilizada.  

 

CONFIGURANDO O RETORNO DA CONSULTA

Uma vez que já realizamos a consulta do CEP, agora precisamos retornar as informações para os campos desejados. Iremos utilizar o seguinte gatilho para o preenchimento dos valores consultados:

Gatilho para preenchimento da consulta

E como ação iremos utilizar “Atualize um campo no card ou registro conectado”. Para este cenário, iremos utilizar “Pipe atual” e então realizar o relacionamento dos campos que existem de retorno na requisição HTTP, do campo JSON schema, como no exemplo a seguir:

Configuração de atualização dos campos por requisição HTTP

Feito isso, basta apenas testar sua automação e espero ter ajudado você a otimizar seu processo!


10 replies

Userlevel 7
Badge +13

Muito legal, Obrigado por compartilhar.

Userlevel 6
Badge +1

Eu faço isso via Make. Bom sber que dá para fazer diretamente pelo Pipefy também. 

 

Obrigado por compartilhar. 

Userlevel 7
Badge +18

Boa tarde pessoal, venho compartilhar com vocês como realizar a configuração das automações de HTTP para realizar consultas de CEP. 

 

CONFIGURANDO A REQUISIÇÃO 

Para gatilho, utilizamos o que fizer mais sentido para seu processo. Como ação, iremos selecionar a opção “Faça uma requisição HTTP” e iremos realizar a seguinte configuração:

Requisição para consulta de CEP
  • Method: GET
  • URLhttps://viacep.com.br/ws/[CAMPO_DINAMICO_CEP]/json/ (utilize um campo numérico pois a informação deve ir apenas números)
  • Authentication: No auth
  • Header/Value: Não precisa preencher

  • Tipo de conteúdo de requisição: JSON

  • Request body: Não precisa preencher

  • Response: Não precisa preencher (apenas caso deseje verificar o retorno da chamada. É uma boa pratica para verificar erros)

  •  

    JSON schema: Este campo será utilizado de base para dizer como é o retorno da chamada HTTP e será utilizado na configuração posterior da automação, sendo necessário para funcionar corretamente

    •     {
      "cep": "01001-000",
      "logradouro": "Praça da Sé",
      "complemento": "lado ímpar",
      "bairro": "Sé",
      "localidade": "São Paulo",
      "uf": "SP",
      "ibge": "3550308",
      "gia": "1004",
      "ddd": "11",
      "siafi": "7107"
      }

Após isso basta salvar e nomear sua automação como desejar. 

  • Caso tenha dúvidas sobre o endpoint utilizado, referente a volume de requisições acesse https://viacep.com.br/ 
  • Caso seu processo tenha um grande volume de consultas, existem APIs de consulta pagas que não irão lhe limitar, sendo necessário ajustar de acordo com a documentação da plataforma utilizada.  

 

CONFIGURANDO O RETORNO DA CONSULTA

Uma vez que já realizamos a consulta do CEP, agora precisamos retornar as informações para os campos desejados. Iremos utilizar o seguinte gatilho para o preenchimento dos valores consultados:

Gatilho para preenchimento da consulta

E como ação iremos utilizar “Atualize um campo no card ou registro conectado”. Para este cenário, iremos utilizar “Pipe atual” e então realizar o relacionamento dos campos que existem de retorno na requisição HTTP, do campo JSON schema, como no exemplo a seguir:

Configuração de atualização dos campos por requisição HTTP

Feito isso, basta apenas testar sua automação e espero ter ajudado você a otimizar seu processo!

 

 

 

Obrigado por compartilhar 

Userlevel 7
Badge +18

Eu faço isso via Make. Bom sber que dá para fazer diretamente pelo Pipefy também. 

 

Obrigado por compartilhar. 

 

Boa alternativa 

Userlevel 7

Massa @gustavo_serbena!
Muito obrigada por compartilhar aqui com todos!😃

Userlevel 1
Badge

Muito massa Gustavo! Obrigado pelo compartilhamento!

Apesar da explicação, não consegui fazer esse processo funcionar. Tenho uma automação do tipo, estou usando formulário com URL pública para preenchimento. Gostaria que quando o usuário preenchesse o campo CEP, o restante dos campos como logradouro e etc,  fossem preenchidos. 

Algum material que poderia resolver esse problema?

Userlevel 3
Badge

Muito massa Gustavo! Obrigado pelo compartilhamento!

Apesar da explicação, não consegui fazer esse processo funcionar. Tenho uma automação do tipo, estou usando formulário com URL pública para preenchimento. Gostaria que quando o usuário preenchesse o campo CEP, o restante dos campos como logradouro e etc,  fossem preenchidos. 

Algum material que poderia resolver esse problema?

Opa, tudo certo? 

Pelo que entendi você está utilizando ela em campos do formulário público, correto? Se sim, nesse caso não temos como utilizar as automações nesse cenário, visto que no momento ainda não existe uma informação básica para as automações, no caso o card id

 

Ou o problema seria outro? Se sim, consegue me dar mais detalhes, consigo tentar te auxiliar por aqui

Userlevel 1
Badge

Opa!

Seria isso mesmo, seria uma atualização mais dinâmica a medida que o formulário está sendo preenchido. Pelo visto, não temos solução para o caso por ora, obrigadão pela ajuda!

Userlevel 3
Badge

Opa!

Seria isso mesmo, seria uma atualização mais dinâmica a medida que o formulário está sendo preenchido. Pelo visto, não temos solução para o caso por ora, obrigadão pela ajuda!

Exatamente, no momento automações e atualizações mais dinâmicas, no startform não temos essa possibilidade infelizmente, espero ter ajudado. 

Userlevel 7
Badge +7

Muito Bom! 

Reply