API de Demander - Ciudades

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar ciudades.

Consulta

Enumere las ciudades de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.

Rota: {host}/public/v1/cidades?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Precaución

Paginación

• pagina — base 1 (predeterminado 1)
• limite — predeterminado 100, máximo 500

Filtros

• filtroDataAlteracao — formato Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (predeterminado >=)

Retorno:

{
  "cidades": [
    {
      "codigo": 54,
      "descricao": "LAJEADO",
      "uf": "RS",
      "codigoPais": "BR",
      "ativo": 1,
      "dataAlteracao": "2026-07-24 10:00:00",
      "codigoIbge": 4311403
    }
  ]
}

Insertar o actualizar

POST inserción mediante la tecla codigo.

Rota: {host}/public/v1/cidades
Método: POST
Body: json

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	entero		✓	Código de ciudad. Identificador único utilizado para insertar o actualizar (upsert).
descripción	cadena	100	✓	Nombre de la ciudad.
uf	cadena	2	✓	UF del estado (ej.: RS).
codigoPais	cadena	2		Código de país ISO-2. Valor predeterminado de inclusión: BR.
codigoIbge	entero	11		Código del municipio en la base del IBGE. La consulta de CEP y CNPJ usa primero este campo para localizar la ciudad.
activo	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 1.

Precaución

Inclusión

• Es necesario enviar todos los atributos que sean obligatorios. Devolver 201.

Actualización

• Sólo el atributo codigo es obligatorio. Devuelve 200.

Cuerpo:

{
  "codigo": 54,
  "descricao": "LAJEADO",
  "uf": "RS",
  "codigoPais": "BR",
  "ativo": 1,
  "codigoIbge": 4311403
}

Retorno:

{
  "codigo": 54,
  "descricao": "LAJEADO",
  "uf": "RS",
  "codigoPais": "BR",
  "ativo": 1,
  "dataAlteracao": "2026-07-24 10:00:00",
  "codigoIbge": 4311403
}

Eliminar

Quitar la ciudad.

Rota: {host}/public/v1/cidades?codigo={codigo}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}

Crear todas las ciudades del IBGE

Copia las ciudades del IBGE a la empresa, con codigoPais = BR. Cada ciudad insertada recibe el código del municipio en codigo y en codigoIbge.

Rota: {host}/public/v1/cidades/criar-todas-cidades-do-ibge
Método: POST

Precaución

Atención

• Si la empresa ya tiene 5000 o más ciudades, la operación no se ejecuta.

Retorno:

{
  "mensagem": "Cidades do IBGE criadas com sucesso.",
  "quantidadeInserida": 5570
}