API de Estados

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
https://api.mosiaomnichannel.com.br/privado/omni/utilitarios/v1/gbe/utilitario/estados	POST	application/json	Retorno json de estados brasileiros

Header

Atualmente não se faz necessário

Parâmetros de entrada

Atualmente não se faz necessário

Exemplo request

curl --request POST \
  --url https://api.mosiaomnichannel.com.br/privado/omni/utilitarios/v1/gbe/utilitario/estados

Objeto de retorno

{
	"status": true,
	"data": [
		{
			"id": 29,
			"uf": "AC",
			"nome": "Acre",
			"codigoIBGE": "12"
		},
		{
			"id": 41,
			"uf": "AL",
			"nome": "Alagoas",
			"codigoIBGE": "27"
		},
		{
			"id": 33,
			"uf": "AP",
			"nome": "Amapá",
			"codigoIBGE": "16"
		},
		{
			"id": 30,
			"uf": "AM",
			"nome": "Amazonas",
			"codigoIBGE": "13"
		},
		{
			"id": 43,
			"uf": "BA",
			"nome": "Bahia",
			"codigoIBGE": "29"
		},
		{
			"id": 37,
			"uf": "CE",
			"nome": "Ceará",
			"codigoIBGE": "23"
		},
		{
			"id": 54,
			"uf": "DF",
			"nome": "Distrito Federal",
			"codigoIBGE": "53"
		},
		{
			"id": 45,
			"uf": "ES",
			"nome": "Espírito Santo",
			"codigoIBGE": "32"
		},
		{
			"id": 53,
			"uf": "GO",
			"nome": "Goiás",
			"codigoIBGE": "52"
		},
		{
			"id": 35,
			"uf": "MA",
			"nome": "Maranhão",
			"codigoIBGE": "21"
		},
		{
			"id": 52,
			"uf": "MT",
			"nome": "Mato Grosso",
			"codigoIBGE": "51"
		},
		{
			"id": 51,
			"uf": "MS",
			"nome": "Mato Grosso do Sul",
			"codigoIBGE": "50"
		},
		{
			"id": 44,
			"uf": "MG",
			"nome": "Minas Gerais",
			"codigoIBGE": "31"
		},
		{
			"id": 32,
			"uf": "PA",
			"nome": "Pará",
			"codigoIBGE": "15"
		},
		{
			"id": 39,
			"uf": "PB",
			"nome": "Paraíba",
			"codigoIBGE": "25"
		},
		{
			"id": 48,
			"uf": "PR",
			"nome": "Paraná",
			"codigoIBGE": "41"
		},
		{
			"id": 40,
			"uf": "PE",
			"nome": "Pernambuco",
			"codigoIBGE": "26"
		},
		{
			"id": 36,
			"uf": "PI",
			"nome": "Piauí",
			"codigoIBGE": "22"
		},
		{
			"id": 46,
			"uf": "RJ",
			"nome": "Rio de Janeiro",
			"codigoIBGE": "33"
		},
		{
			"id": 38,
			"uf": "RN",
			"nome": "Rio Grande do Norte",
			"codigoIBGE": "24"
		},
		{
			"id": 50,
			"uf": "RS",
			"nome": "Rio Grande do Sul",
			"codigoIBGE": "43"
		},
		{
			"id": 28,
			"uf": "RO",
			"nome": "Rondônia",
			"codigoIBGE": "11"
		},
		{
			"id": 31,
			"uf": "RR",
			"nome": "Roraima",
			"codigoIBGE": "14"
		},
		{
			"id": 49,
			"uf": "SC",
			"nome": "Santa Catarina",
			"codigoIBGE": "42"
		},
		{
			"id": 47,
			"uf": "SP",
			"nome": "São Paulo",
			"codigoIBGE": "35"
		},
		{
			"id": 42,
			"uf": "SE",
			"nome": "Sergipe",
			"codigoIBGE": "28"
		},
		{
			"id": 34,
			"uf": "TO",
			"nome": "Tocantins",
			"codigoIBGE": "17"
		}
	],
	"message": "Estados listados com sucesso",
	"critical": [],
	"statusCode": 200,
	"timestamp": 1672234319089
}

Exemplo a ser utilizado no formbuilder

Selecione o componente do tipo “Seleção API”

Selecione a aba “Dados”;
Insira a API de estados no campo “URL”;
1. No header da requisição colocamos um limit de valor 100;
Preencha as propriedades da Label e Value com o valor desejado que seja retornado no campo de seleção, em nosso caso selecionamos “nome” para label e “uf” para value;
Na prévia será visto o resultado que pode também ser acompanhando posteriormente nos Apps;