Inicio

API

1. Primeiros passos

3. Modelos de anúncios da API

4. Entrar em produção

5. Callbacks

6. Mostrar localização no mapa

8. Integração ReadOnly

9.Associar Imobiliárias

XML

1. Primeiros passos

2. Exemplos de XML por país

3. Estrutura para Anúncios

3.1 Campos obrigatórios

4. Estrutura para Lançamentos

4.1 Campos obrigatórios

5. Erros comuns XML

6. Como ler o XML do resultado?

7. Passar para produção

8. Callbacks

9. Mostrar localização no mapa

Médio

1. Criar ou modificar um anúncio

A API utiliza uma lógica de "criar ou atualizar" (Upsert). Você usará o mesmo método PUT tanto para registrar um novo anúncio quanto para modificar um existente, identificado pelo seu codigoAviso na URL.

Endpoint:

PUT /v1/inmobiliarias/{codigoInmobiliaria}/avisos/{codigoAviso}

<aside> ⚠️

Importante: Antes de executar esta operação, verifique se a imobiliária conta com créditos disponíveis para o tipoDePublicacion desejado, consultando o endpoint de disponibilidade.

</aside>

Exemplo de Peticão (cURL)

O seguinte exemplo está desenhado para ser o mais completo possível e evitar advertências (warnings).

curl --location --request PUT '<https://api-iwbr-sandbox-open.navent.com/v1/imobiliarias/><TU_CODIGO_INMOBILIARIA>/anuncios/<TU_CODIGO_ANUNCIO>' \\
--header 'Authorization: Bearer <TU_ACCESS_TOKEN>' \\
--header 'User-Agent: MiCRMInmobiliario/2.1 ([email protected])' \\
--header 'Content-Type: application/json' \\
--data '{
  "codigoAviso": "AP00017",
  "claveReferencia": "AP00017",
  "titulo": "Apartamento, Agua Verde, Curitiba, PR",
  "descripcion": "APT. SEMIMOBILIADO para Locação, AGUA VERDE, CURITIBA-RUA MATO GROSSO, 491 A 3 QUADRAS DO SHOPING AGUA VERDE.  SEMIMOBILIADO COM 02 QUARTOS, SALA, COZINHA CON ARMARIOS  -FOGÃO GELADEIRA,  , ARMARIO QUARTO, MAQ. LAVAR, , ETC.dormitórios, 01 salas, 01 banheiros, garagem 01 vagas livre para 1 carro pequeno - 16/10/2025",
  "tipoDePropiedad": {
    "idTipo": "2",
    "tipo": "Apartamento",
    "idSubTipo": "1",
    "subTipo": "Padrão"
  },
  "caracteristicas": [
    {
      "id": "30004",
      "nombre": "OTROS|POSIÇÃO_DO_APTO",
      "valor": "Lateral",
      "idValor": "300043"
    },
    {
      "id": "2000199",
      "nombre": "GENERALES|COMPLEMENTO",
      "valor": "BL: 1, AP: 13",
      "idValor": null
    },
    {
      "id": "CFT4",
      "nombre": "PRINCIPALES|SUITE",
      "valor": "0",
      "idValor": null
    },
    {
      "id": "CFT3",
      "nombre": "PRINCIPALES|BANHEIRO",
      "valor": "1",
      "idValor": null
    },
    {
      "id": "CFT2",
      "nombre": "PRINCIPALES|QUARTO",
      "valor": "2",
      "idValor": null
    },
    {
      "id": "CFT400",
      "nombre": "PRINCIPALES|IPTU",
      "valor": "80.0",
      "idValor": null
    },
    {
      "id": "CFT7",
      "nombre": "PRINCIPALES|VAGA",
      "valor": "1",
      "idValor": null
    },
    {
      "id": "CFT6",
      "nombre": "PRINCIPALES|CONDOMINIO",
      "valor": "400.0",
      "idValor": null
    },
    {
      "id": "CON1",
      "nombre": "MEDIDAS|UNIDAD_DE_MEDIDA",
      "valor": "Metro Cuadrado",
      "idValor": "M2"
    },
    {
      "id": "CFT101",
      "nombre": "MEDIDAS|AREA_UTIL",
      "valor": "60",
      "idValor": null
    },
    {
      "id": "CFT100",
      "nombre": "MEDIDAS|AREA_TOTAL",
      "valor": "60",
      "idValor": null
    }
  ],
  "precios": [
    {
      "monto": "2500",
      "moneda": "BRL",
      "operacion": "ALQUILER"
    }
  ],
  "multimedia": {
    "imagenes": [
      {
        "titulo": "Foto 01",
        "urlImagenPortal": "<https://preprostatic.imovelwebcdn.com/avisos/2/29/31/74/83/50/1200x1200/5587429385.jpg>",
        "urlImagenOriginal": "<https://cdnuso.com/14331/2017/05/52954209.jpg>"
      },
      {
        "titulo": "Foto 02",
        "urlImagenPortal": "<https://preprostatic.imovelwebcdn.com/avisos/2/29/31/74/83/50/1200x1200/5587429387.jpg>",
        "urlImagenOriginal": "<https://cdnuso.com/14331/2017/05/52954211.jpg>"
      }
    ],
    "videos": null,
    "recorridos360": null,
    "planos": []
  },
  "localizacion": {
    "idUbicacion": "V1-D-508618",
    "ubicacion": "Água Verde, Curitiba, Paraná, Brasil",
    "direccion": "Rua Mato Grosso, 491",
    "latitud": "-25.464840599999998",
    "longitud": "-49.285538400000000",
    "muestraMapa": "EXACTO",
    "codigoPostal": "80620070"
  },
  "publicacion": {
    "tipoDePublicacion": "HOME",
    "fechaOnline": 1760449446000,
    "fechaOffline": null
  },
  "publicador": {
    "codigoInmobiliaria": "15586260",
    "emailAsesor": "[email protected]",
    "emailDeContacto": "[email protected]",
    "nombreDeContacto": "test Imóveis",
    "telefonoDeContacto": "2222222",
    "callbackTokenClient": null
  },
  "estado": "PROCESADO",
  "traceId": null
}'

Resposta exitosa (200 OK)

Se a imobiliária tem créditos, o anúncio é processado e fica ONLINE imediatamente.

{
  "idAviso": 3020873347,
  "idEmpresa": 15586260,
  "codigoAviso": "teste-001",
  "codigoInmobiliaria": "15586260",
  "estado": "OFFLINE",
  "informacion": [
    {
      "idMessage": 14862823710,
      "idAviso": 3020873347,
      "idInterfaceRun": null,
      "messageType": "INFO",
      "messageCode": "I-PLH",
      "messageText": "HOME"
    }
  ],
  "warnings": [
    {
      "idMessage": 14862823708,
      "idAviso": 3020873347,
      "idInterfaceRun": null,
      "messageType": "WARNING",
      "messageCode": "WARN-0207",
      "messageText": "El aviso no tiene planos."
    },
    {
      "idMessage": 14862823709,
      "idAviso": 3020873347,
      "idInterfaceRun": null,
      "messageType": "WARNING",
      "messageCode": "WARN-104",
      "messageText": "El numero de telefono 2222222 es invalido"
    }
  ],
  "idAvisoPadre": null,
  "codigoAvisoPadre": null,
  "errors": [
    {
      "idMessage": 14862823707,
      "idAviso": 3020873347,
      "idInterfaceRun": null,
      "messageType": "ERROR",
      "messageCode": "ERR-0502",
      "messageText": "La empresa tiene utilizados todos sus disponibles"
    }
  ],
  "error": true
}

2. Obter um anúncio

Consulta a informação completa de um anúncio já processado.

Endpoint:

**PUT /v1/inmobiliarias/{codigoInmobiliaria}/avisos/{codigoAviso}**

Exemplo de Peticão (cURL)

curl --location --request GET '<https://api-iwbr-sandbox-open.navent.com/v1/imobiliarias/><TU_CODIGO_INMOBILIARIA>/anuncios/<TU_CODIGO_ANUNCIO>' \\
--header 'Authorization: Bearer <TU_ACCESS_TOKEN>' \\
--header 'User-Agent: MiCRMInmobiliario/2.1 ([email protected])'

Resposta exitosa (200 OK)

O campo estado nesta resposta indica se o anúncio está ONLINE ou OFFLINE no portal.

{
 "codigoAviso": "TU_CODIGO_ANUNCIO",
 "claveReferencia": "TU_CODIGO_REFERENCIA",
 "titulo": "Apartamento, Agua Verde, Curitiba, PR",
 "descripcion": "APT. SEMIMOBILIADO para Locação, AGUA VERDE, CURITIBA-RUA MATO GROSSO, 491 A 3 QUADRAS DO SHOPING AGUA VERDE.  SEMIMOBILIADO COM 02 QUARTOS, SALA, COZINHA COM ARMARIOS  -FOGÃO GELADEIRA,  , ARMARIO QUARTO, MAQ. LAVAR, , ETC.dormitórios, 01 salas, 01 banheiros, garagem 01 vagas livre para 1 carro pequeno - 16/10/2025",
 "tipoDePropiedad": {
   "idTipo": "2",
   "tipo": "Apartamento",
   "idSubTipo": "1",
   "subTipo": "Padrão"
 },
 "caracteristicas": [
   {
     "id": "30004",
     "nombre": "OTROS|POSIÇÃO_DO_APTO",
     "valor": "Lateral",
     "idValor": "300043"
   },
   {
     "id": "2000199",
     "nombre": "GENERALES|COMPLEMENTO",
     "valor": "BL: 1, AP: 13",
     "idValor": null
   },
   {
     "id": "CFT4",
     "nombre": "PRINCIPALES|SUITE",
     "valor": "0",
     "idValor": null
   },
   {
     "id": "CFT3",
     "nombre": "PRINCIPALES|BANHEIRO",
     "valor": "1",
     "idValor": null
   },
   {
     "id": "CFT2",
     "nombre": "PRINCIPALES|QUARTO",
     "valor": "2",
     "idValor": null
   },
   {
     "id": "CFT400",
     "nombre": "PRINCIPALES|IPTU",
     "valor": "80.0",
     "idValor": null
   },
   {
     "id": "CFT7",
     "nombre": "PRINCIPALES|VAGA",
     "valor": "1",
     "idValor": null
   },
   {
     "id": "CFT6",
     "nombre": "PRINCIPALES|CONDOMINIO",
     "valor": "400.0",
     "idValor": null
   },
   {
     "id": "CON1",
     "nombre": "MEDIDAS|UNIDAD_DE_MEDIDA",
     "valor": "Metro Cuadrado",
     "idValor": "M2"
   },
   {
     "id": "CFT101",
     "nombre": "MEDIDAS|AREA_UTIL",
     "valor": "60",
     "idValor": null
   },
   {
     "id": "CFT100",
     "nombre": "MEDIDAS|AREA_TOTAL",
     "valor": "60",
     "idValor": null
   }
 ],
 "precios": [
   {
     "monto": "2500",
     "moneda": "BRL",
     "operacion": "ALQUILER"
   }
 ],
 "multimedia": {
   "imagenes": [
     {
       "titulo": "Foto 01",
       "urlImagenPortal": "<https://preprostatic.imovelwebcdn.com/avisos/2/29/31/74/83/50/1200x1200/5587429385.jpg>",
       "urlImagenOriginal": "<https://cdnuso.com/14331/2017/05/52954209.jpg>"
     },
     {
       "titulo": "Foto 02",
       "urlImagenPortal": "<https://preprostatic.imovelwebcdn.com/avisos/2/29/31/74/83/50/1200x1200/5587429387.jpg>",
       "urlImagenOriginal": "<https://cdnuso.com/14331/2017/05/52954211.jpg>"
     }
   ],
   "videos": null,
   "recorridos360": null,
   "planos": []
 },
 "localizacion": {
   "idUbicacion": "V1-D-508618",
   "ubicacion": "Água Verde, Curitiba, Paraná, Brasil",
   "direccion": "Rua Mato Grosso, 491",
   "latitud": "-25.464840599999998",
   "longitud": "-49.285538400000000",
   "muestraMapa": "EXACTO",
   "codigoPostal": "80620070"
 },
 "publicacion": {
   "tipoDePublicacion": "HOME",
   "fechaOnline": 1760449446000,
   "fechaOffline": null
 },
 "publicador": {
   "codigoInmobiliaria": "15586260",
   "emailAsesor": "[email protected]",
   "emailDeContacto": "[email protected]",
   "nombreDeContacto": "test Imóveis",
   "telefonoDeContacto": "2222222",
   "callbackTokenClient": null
 },
 "estado": "PROCESADO",
 "traceId": null
}

3. Colocar um anúncio offline

Esta operação desativa o anúncio do portal (coloca-o em estado OFFLINE), mas não o elimina permanentemente.

Endpoint:

**DELETE /v1/inmobiliarias/{codigoInmobiliaria}/avisos/{codigoAviso}**

cURL

curl --location --request DELETE '<https://api-iwbr-sandbox-open.navent.com/v1/imobiliarias/><TU_CODIGO_INMOBILIARIA>/anuncios/<TU_CODIGO_ANUNCIO>' \\
--header 'Authorization: Bearer <TU_ACCESS_TOKEN>' \\
--header 'User-Agent: MiCRMInmobiliario/2.1 ([email protected])'

Resposta exitosa (200 OK)

[
  {
    "idAviso": 3018371361,
    "idEmpresa": 47610496,
    "codigoAviso": "ONQA-001-e",
    "codigoInmobiliaria": "47610496",
    "estado": "OFFLINE",
    "informacion": [
      {
        "idMessage": 13373928349,
        "idAviso": 3018371361,
        "idInterfaceRun": null,
        "messageType": "INFO",
        "messageCode": "I-ELIM",
        "messageText": "El aviso se elimino."
      }
    ],
    "warnings": [],
    "idAvisoPadre": null,
    "codigoAvisoPadre": null,
    "errors": [],
    "error": false
  }
]

4. Imóvel novo (lançamento com unidades)

A gestão de um imóvel novo é realizada através de um endpoint específico. A peticão PUT deve conter tanto os dados do imóvel novo pai quanto a array completa de suas unidades.

Endpoint:

**PUT /v1/inmobiliarias/{codigoInmobiliaria}/desarrollos/{codigoDesarrollo}**

Processamento assincrônico: se um imóvel novocontém mais de 15 unidades, a API processará a solicitação de forma assincrônica. Neste caso, a resposta imediata terá um estado de EN_ESPERA. Você deverá consultar o estado do imóvel novo posteriormente para verificar sua publicação.

Exemplo de Peticão (cURL para um imóvel novo com 2 Unidades)

curl --location --request PUT '<https://api-iwbr-sandbox-open.navent.com/v1/inmobiliarias/><TU_CODIGO_INMOBILIARIA>/desarrollos/<TU_CODIGO_LANCAMENTO>' \\
--header 'Authorization: Bearer <TU_ACCESS_TOKEN>' \\
--header 'User-Agent: MiCRMInmobiliario/2.1 ([email protected])' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "codigoAviso": "EDIFICIO-CENTRO-XXI",
    "publicador": { "codigoInmobiliaria": "ontest1", "nombreDeContacto": "Constructora Principal" },
    "publicacion": { "tipoDePublicacion": "DESARROLLOS_DESTACADO_COMBO" },
    "titulo": "Edificio Centro XXI - Unidades de Lujo",
    "descripcion": "Moderno desarrollo vertical en etapa de pre-venta. Contará con amenidades de primer nivel como alberca, gimnasio y business center.",
    "tipoDePropiedad": { "idTipo": "34" },
    "localizacion": { "idUbicacion": "V1-C-1245", "direccion": "Reforma 222", "muestraMapa": "EXACTO" },
    "etapaDesarrollo": "2",
    "unidades": [
        {
            "codigoAviso": "ED-CXXI-DEPTO-101",
            "titulo": "Departamento 2 Recámaras Vista Interior",
            "descripcion": "Unidad funcional de 2 recámaras y 2 baños completos. Ideal para inversión.",
            "tipoDePropiedad": { "idTipo": "2" },
            "precios": [{ "operacion": "VENTA", "monto": "5500000", "moneda": "MXN" }],
            "caracteristicas": [{ "id": "CFT101", "valor": "90" }, { "id": "CFT2", "valor": "2" }, { "id": "CFT3", "valor": "2" }]
        },
        {
            "codigoAviso": "ED-CXXI-DEPTO-102",
            "titulo": "Departamento 3 Recámaras con Balcón",
            "descripcion": "Amplia unidad de 3 recámaras, principal con vestidor. Balcón con excelente vista.",
            "tipoDePropiedad": { "idTipo": "2" },
            "precios": [{ "operacion": "VENTA", "monto": "7200000", "moneda": "MXN" }],
            "caracteristicas": [{ "id": "CFT101", "valor": "120" }, { "id": "CFT2", "valor": "3" }, { "id": "CFT3", "valor": "3" }]
        }
    ]
}'