API de Integração - Cidades

Cidades

Cidades

Propriedades

id	number
nome	string
uf	string
cep	string
codIbge	number

Endpoints

GET /api/cidades/{UF}

Retorna uma lista de cidades da UF informada.

Parâmetros

Nome	Descrição	Tipo
uf	Nome da UF	string
nome	Nome da Cidade	string

Exemplo

curl --request GET \
     --url ${URL_BASE}/api/cidades/RS \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure

HTTP/1.1 200 OK  

[
  {
    "id": 21,
    "nome": "Aceguá",
    "uf": "RS",
    "cep": "96445-000",
    "codIbge": 4300034
  },
  {
    "id": 6609,
    "nome": "Aceguá",
    "uf": "RS",
    "cep": "96445-000",
    "codIbge": 4300034
  },
  {
    "id": 937,
    "nome": "Água Santa",
    "uf": "RS",
    "cep": "99955-000",
    "codIbge": 4300059
  },
  {
    "id": 6435,
    "nome": "Água Santa",
    "uf": "RS",
    "cep": null,
    "codIbge": 4300059
  },
  {
    "id": 804,
    "nome": "Agudo",
    "uf": "RS",
    "cep": "96540-000",
    "codIbge": 4300109
  }
]

curl --request GET \
     --url ${URL_BASE}/api/cidades/RS?nome=Erechim \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure  

HTTP/1.1 200 OK

[
  {
    "id":2,
    "nome":"Erechim",
    "uf":"RS",
    "cep":"99700-000",
    "codIbge":4307005
  }
]