API de Cidades
As API’s encontram-se abertas, mas futuramente as mesmas podem receber tratativas de Authorization para requests externos.
Importante
Esta requisição deve ser feita posteriormente do resultado da API de Estados, ou seja a API de Cidades necessita da saída de dados da API de Estados para assim realizar o seu request.
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
https://api.mosiaomnichannel.com.br/privado/omni/utilitarios/v1/gbe/utilitario/cidades | POST | application/json | Retorno json das cidades brasileiras, previamente selecionadas de um determinado estado |
Header
Caso queira customizar o nome do atributo do BODY que contem o estado, você pode enviar um cabeçalho chamado custom-var-name-estado com o nome do atributo enviado no body. Isso se faz necessário para quando precisa-se usar a API de utilitários e mais de um campo de cidade (Exemplo: Endereço residencial e Endereço de naturalidade).
Parâmetros de entrada
Resultado do request anterior feito pela API de estados
nome | Obrigatório | Tipo | Valor padrão | Descrição |
|---|---|---|---|---|
estado | status:SIM | Array |
| Recebe o Array: [
{
"value": "SC",
"label": [
"Florianópolis"
]
}
] |
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/cidades \
--header 'Content-Type: application/json' \
--data '{
"estado": [
{
"value": "SC",
"label": [
"Florianópolis"
]
}
]
}'
Objeto de retorno
{
"status": true,
"data": [
{
"id": 8319,
"uf": "SC",
"nome": "Abdon Batista",
"cep": "89636000",
"codigoIBGE": "4200051"
},
{
"id": 8320,
"uf": "SC",
"nome": "Abelardo Luz",
"cep": "89830000",
"codigoIBGE": "4200101"
},
{
"id": 8321,
"uf": "SC",
"nome": "Agrolândia",
"cep": "88420000",
"codigoIBGE": "4200200"
},
{
"id": 8322,
"uf": "SC",
"nome": "Agronômica",
"cep": "89188000",
"codigoIBGE": "4200309"
},
{
"id": 8323,
"uf": "SC",
"nome": "Água Doce",
"cep": "89654000",
"codigoIBGE": "4200408"
},
{
"id": 8326,
"uf": "SC",
"nome": "Águas de Chapecó",
"cep": "89883000",
"codigoIBGE": "4200507"
},
{
"id": 8327,
"uf": "SC",
"nome": "Águas Frias",
"cep": "89843000",
"codigoIBGE": "4200556"
},
{
"id": 8328,
"uf": "SC",
"nome": "Águas Mornas",
"cep": "88150000",
"codigoIBGE": "4200606"
},
{
"id": 8331,
"uf": "SC",
"nome": "Alfredo Wagner",
"cep": "88450000",
"codigoIBGE": "4200705"
},
{
"id": 8333,
"uf": "SC",
"nome": "Alto Bela Vista",
"cep": "89730000",
"codigoIBGE": "4200754"
},
{
"id": 8335,
"uf": "SC",
"nome": "Anchieta",
"cep": "89970000",
"codigoIBGE": "4200804"
},
{
"id": 8336,
"uf": "SC",
"nome": "Angelina",
"cep": "88460000",
"codigoIBGE": "4200903"
},
{
"id": 8337,
"uf": "SC",
"nome": "Anita Garibaldi",
"cep": "88590000",
"codigoIBGE": "4201000"
},
{
"id": 8338,
"uf": "SC",
"nome": "Anitápolis",
"cep": "88475000",
"codigoIBGE": "4201109"
},
{
"id": 8340,
"uf": "SC",
"nome": "Antônio Carlos",
"cep": "88180000",
"codigoIBGE": "4201208"
},
{
"id": 8341,
"uf": "SC",
"nome": "Apiúna",
"cep": "89135000",
"codigoIBGE": "4201257"
},
{
"id": 8342,
"uf": "SC",
"nome": "Arabutã",
"cep": "89740000",
"codigoIBGE": "4201273"
},
{
"id": 8343,
"uf": "SC",
"nome": "Araquari",
"cep": "89245000",
"codigoIBGE": "4201307"
},
{
"id": 8344,
"uf": "SC",
"nome": "Araranguá",
"cep": "",
"codigoIBGE": "4201406"
},
{
"id": 8345,
"uf": "SC",
"nome": "Armazém",
"cep": "88740000",
"codigoIBGE": "4201505"
},
{
"id": 8347,
"uf": "SC",
"nome": "Arroio Trinta",
"cep": "89590000",
"codigoIBGE": "4201604"
},
{
"id": 8348,
"uf": "SC",
"nome": "Arvoredo",
"cep": "89778000",
"codigoIBGE": "4201653"
},
{
"id": 8349,
"uf": "SC",
"nome": "Ascurra",
"cep": "89138000",
"codigoIBGE": "4201703"
},
{
"id": 8350,
"uf": "SC",
"nome": "Atalanta",
"cep": "88410000",
"codigoIBGE": "4201802"
},
{
"id": 8352,
"uf": "SC",
"nome": "Aurora",
"cep": "89186000",
"codigoIBGE": "4201901"
}
],
"message": "Cidades listadas com sucesso",
"critical": [],
"statusCode": 200,
"timestamp": 1672242635249
}
Exemplo de request com custom-var-name-estado
curl --location 'https://api.mosiaomnichannel.com.br/privado/omni/utilitarios/v1/gbe/utilitario/cidades' \
--header 'custom-var-name-estado: uf-naturalidade' \
--header 'Content-Type: application/json' \
--data '{
"uf-naturalidade": [
{
"value": "ES",
"label": [
"Espirito Santo"
]
}
]
}'
Exemplo a ser utilizado no formbuilder
Selecione o componente do tipo “Seleção API”
Selecione a aba "Dados”;
Insira a API de cidades no campo “URL”;
Em "Dados para Requisição” selecione o tipo “Componente” e no campo “Valor” selecione o componente de estados de que foi criado anteriormente;
Em propriedades de “Label” e “Value” preencha com “nome” e “uf” respectivamente.
IMPORTANTE: para a seleção de cidades funcionar é necessário selecionar um estado primeiramente, selecionamos no exemplo: “Santa Catarina"
A partir disso selecionando a API Cidades verificamos que são exibidas as cidades de Santa Catarina.
Iremos realizar aqui outros exemplos com outros estados e cidades;
Distrito Federal
São Paulo
Rio de Janeiro
É recomendado o uso do “Modo autocomplete" para o campo de “Seleção API”
Para adicionar o "Modo autocomplete", selecione a aba "Aparência" e ative o campo “Modo Autocomplete"
Related content
Mobile Saúde - Mosia Omnichannel