TOTVS Moda

Páginas filhas
  • DR VA Integração API Consulta CEP - Consulta

O cadastro do CEP pode ser realizada de duas maneiras, manual ou automática. 

O cadastro manual consiste em abrir um ticket para o Suporte da Virtual Age e aguardar que o cadastro seja realizado. 

O cadastro automático necessita da configuração do parâmetro DS_URL_API_CONSULTA_CEP que é configurado através da tela ADMFM014.

Imagem 1 - Demonstração da tela ADMFM014 com o parâmetro configurado apenas para a empresa 01.


Com o cadastro automático, toda vez que for informado na tela PESFM010 um CEP que ainda não existe na base de dados, é realizado a consulta das informações no site dos Correios, existindo o CEP, é inserido as informações no banco de dados e apresentado as informações para o usuário em tela. 

Caso o CEP já exista na base de dados é retornado a informação em tela para o usuário.

Imagem 2 - Demonstração da tela PESFM010 apresentando um CEP consultado através da API.

A consulta da API pode ser realizada fora do Sistema, através de qualquer aplicação. 

URL
https://www30.bhan.com.br:9443/api/v1/cep/consulta
MÉTODO
POST
EXEMPLO REQUISIÇÃO 
{
 "cdCep" : "99999999" 
}
EXEMPLO RESPOSTA 
{
    "cdCEP": "99999999",                  código do CEP. 
    "cdTipoLogradouro": 9999999999,       código do tipo do logradouro, exemplo. 
    "dsTipoLogradouro": "x",              descrição do tipo do logradouro, exemplo: R (Rua), AV (Avenida),... 
    "dsEndereco": "xxxxxxxx",             descrição do endereço. 
    "dsComplemento": "xxxxxxxx",          descrição do complemento. 
    "cdBairro": 9999999999,               código do bairro. 
    "dsBairro": "xxxxxxxx",               descrição do nome do bairro. 
    "cdCidade": 9999999999,               código da cidade. 
    "cdCidadeIbge": 9999999999,           código do IBGE (Instituto Brasileiro de Geografia e Estatística) da cidade. 
    "dsCidade": "xxxxxxxx",               descrição do nome da cidade. 
    "cdEstado": 99,                       código do estado. 
    "cdEstadoIbge": 99,                   código do IBGE (Instituto Brasileiro de Geografia e Estatística) do estado. 
    "dsEstado": "xxxxxxxx",               descrição do nome do estado. 
    "cdPais": 999,                        código do país. 
    "dsPais": "xxxxxxxx",                 descrição do nome do país. 
    "cdPaisBCB": 9999999999               código do país no Banco Central do Brasil. 
}
  • Sem rótulos