API de CEP

1 Endpoint
2 Header
3 Parâmetros de entrada
4 Exemplo request
5 Objeto de retorno
6 Exemplo a ser utilizado no formbuilder
7 Resultado

As API’s encontram-se abertas, mas futuramente as mesmas podem receber tratativas de Authorization para requests externos.

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
https://api.mosiaomnichannel.com.br/privado/omni/utilitarios/v1/gbe/utilitario/cep	POST	application/json	Retorno json com estado, cidade, logradouro e bairro a partir do cep informado na requisição.

Header

Atualmente não se faz necessário

Parâmetros de entrada

nome	Obrigatório	Tipo	Valor padrão	Descrição

nome	Obrigatório	Tipo	Valor padrão	Descrição
cep	status:SIM	String		Recebe o cep da busca
acentuacao	status:não	String	“true“	Quando passado “false“ neste campo, os textos são retornados sem acentuação.
lowerCase	status:não	String	“false“	Possibilita o retorno dos textos com letra minúscula.
upperCase	status:não	String	“false“	Possibilita o retorno dos textos com letra maiúscula.

Exemplo request

curl --request POST \
  --url https://api.mosiaomnichannel.com.br/privado/omni/utilitarios/v1/gbe/utilitario/cep \
  --header 'Content-Type: application/json' \
  --data '{
    "cep":"88037-060"
}'

Objeto de retorno

{
	"status": true,
	"data": {
		"cep": "88037060",
		"estado": [
			{
				"value": "SC",
				"label": [
					"SC"
				]
			}
		],
		"cidade": [
			{
				"value": "4205407",
				"label": [
					"Florianópolis"
				]
			}
		],
		"logradouro": "Rua Capitão Américo",
		"bairro": "Córrego Grande"
	},
	"message": "CEP encontrado",
	"critical": [],
	"statusCode": 200,
	"timestamp": 1672238275231
}

Exemplo a ser utilizado no formbuilder

Selecione o componente do tipo “Texto” para informar o CEP

Selecione a aba “Eventos”
Habilite a opção “Possui eventos?”
Preencha com a url de API CEP
Em “Dados da Requisição” selecione o tipo “componente” de texto criado para “CEP”
1. Criar componente do tipo texto para o “logradouro”;
2. Criar um componente do tipo texto para “Bairro”;
3. Criar um componente do tipo “Seleção API” para o “Estado”;
4. Criar um componente do tipo “Seleção API” para a “Cidade”;
Habilitar as “Trigger” para habilitar o preenchimento dos campos:
1. Propriedade do Json "logradouro” e componente “Logradouro”;
2. Propriedade do Json "bairro” e componente “Bairro”;
3. Propriedade do Json "cidade” e componente “Seleção API - Cidade”;
4. Propriedade do Json "estado” e componente “Seleção API - Estado”;

Mosia Omnichannel