8. Integración de sólo lectura
4. Estructura para desarrollos
6. ¿Cómo leer el XML de resultado?
La API utiliza una lógica de "crear o actualizar" (Upsert). Usarás el mismo método PUT tanto para dar de alta un nuevo aviso como para modificar uno existente, identificado por su codigoAviso en la URL.
Endpoint:
**PUT/v1/inmobiliarias/{codigoInmobiliaria}/avisos/{codigoAviso}**
<aside> ⚠️
Importante**:** antes de ejecutar esta operación, verifica que la inmobiliaria cuenta con créditos disponibles para el tipoDePublicacion deseado consultando el endpoint de disponibilidad.
</aside>
Ejemplo de petición (cURL)
El siguiente ejemplo está diseñado para ser lo más completo posible y evitar advertencias (warnings).
curl --location --request PUT '<https://api-rela-sandbox-open.navent.com/v1/inmobiliarias/><TU_CODIGO_INMOBILIARIA>/avisos/<TU_CODIGO_AVISO>' \\
--header 'Authorization: Bearer <TU_ACCESS_TOKEN>' \\
--header 'Content-Type: application/json' \\
--header 'User-Agent: MiCRMInmobiliario/2.1 ([email protected])' \\
--data-raw '{
"codigoAviso": "<TU_CODIGO_AVISO>",
"publicador": {
"codigoInmobiliaria": "<TU_CODIGO_INMOBILIARIA>",
"nombreDeContacto": "Juan Pérez",
"emailDeContacto": "[email protected]",
"telefonoDeContacto": "+529511234567"
},
"publicacion": {
"tipoDePublicacion": "DESTACADO_COMBO"
},
"titulo": "Exclusivo Penthouse en el Corazón de Oaxaca",
"descripcion": "Espectacular Penthouse de lujo con acabados de primera y terraza con vista panorámica. Ubicado en una de las zonas más exclusivas de la ciudad, cuenta con seguridad 24/7, alberca y gimnasio.",
"tipoDePropiedad": { "idTipo": "2", "idSubTipo": "101" },
"localizacion": {
"idUbicacion": "V1-C-1245",
"direccion": "Avenida de la Independencia 100, Piso 20, Depto PH-A",
"codigoPostal": "68000",
"latitud": "17.0624",
"longitud": "-96.7251",
"muestraMapa": "APROXIMADO"
},
"precios": [{ "operacion": "VENTA", "monto": "8500000", "moneda": "MXN" }],
"caracteristicas": [
{ "id": "CFT100", "valor": "320" }, { "id": "CFT101", "valor": "280" },
{ "id": "CFT2", "valor": "3" }, { "id": "CFT3", "valor": "3" },
{ "id": "CFT4", "valor": "1" }, { "id": "CFT7", "valor": "2" },
{ "id": "201", "idValor": "4" }
],
"multimedia": {
"imagenes": [{ "titulo": "Terraza con vista panorámica", "urlImagenOriginal": "<https://midominio.com/fotos/penthouse_terraza.jpg>" }],
"planos": [{ "titulo": "Plano de la planta principal", "urlImagenOriginal": "<https://midominio.com/planos/penthouse_plano.jpg>" }]
},
"claveReferencia": "VENTA-PH-CENTRO"
}'
Respuesta exitosa (200 OK)
Si la inmobiliaria tiene créditos, el aviso se procesa y queda ONLINE inmediatamente.
{
"idAviso": 1234567,
"idEmpresa": 1234567,
"codigoAviso": "<TU_CODIGO_AVISO>",
"codigoInmobiliaria": "<TU_CODIGO_INMOBILIARIA>",
"estado": "ONLINE",
"informacion": [
{
"messageCode": "I-PLDC",
"messageText": "DESTACADO_COMBO"
}
],
"warnings": [],
"errors": [],
"error": false
}
Consulta la información completa de un aviso ya procesado.
Endpoint:
**PUT /v1/inmobiliarias/{codigoInmobiliaria}/avisos/{codigoAviso}**
Respuesta exitosa (200 OK)
El campo estado en esta respuesta indica si el aviso está ONLINE u OFFLINE en el portal.
{
"codigoAviso": "<TU_CODIGO_AVISO>",
"estado": "ONLINE",
"titulo": "Exclusivo Penthouse en el Corazón de Oaxaca",
"tipoDePropiedad": { "idTipo": "2", "tipo": "Departamento", "idSubTipo": "101", "subTipo": "Departamento PentHouse" },
"localizacion": { "idUbicacion": "V1-C-1245", "ubicacion": "Oaxaca de Juárez, Oaxaca, Mexico" },
"precios": [{ "operacion": "VENTA", "monto": "8500000", "moneda": "MXN" }],
"multimedia": { "imagenes": [{ "titulo": "Terraza con vista panorámica", "urlImagenPortal": "..." }] }
}
Esta operación da de baja el aviso del portal (lo pone en estado OFFLINE), pero no lo elimina permanentemente.
Endpoint:
**DELETE /v1/inmobiliarias/{codigoInmobiliaria}/avisos/{codigoAviso}**
Respuesta 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
}
]
La gestión de un desarrollo se realiza a través de un endpoint específico. La petición PUT debe contener tanto los datos del desarrollo padre como el array completo de sus unidades.
Endpoint:
**PUT /v1/inmobiliarias/{codigoInmobiliaria}/desarrollos/{codigoDesarrollo}**
Procesamiento asincrónico: si un desarrollo contiene más de 15 unidades, la API procesará la solicitud de forma asincrónica. En este caso, la respuesta inmediata tendrá un estado de EN_ESPERA. Deberás consultar el estado del desarrollo posteriormente para verificar su publicación.
Ejemplo de Petición (cURL para un Desarrollo con 2 Unidades)
curl --location --request PUT '<https://api-rela-sandbox-open.navent.com/v1/inmobiliarias/><TU_CODIGO_INMOBILIARIA>/desarrollos/EDIFICIO-CENTRO-XXI' \\
--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" }]
}
]
}'
Respuesta exitosa (200 OK)
Si la inmobiliaria tiene créditos, el desarrollo se procesa y queda ONLINE inmediatamente.
{
"idAviso": 3018371361,
"idEmpresa": 47610496,
"codigoAviso": "ONQA-001-e",
"codigoInmobiliaria": "47610496",
"estado": "ONLINE",
"informacion": [],
"warnings": [
{
"idMessage": null,
"idAviso": 3018371361,
"idInterfaceRun": null,
"messageType": "WARNING",
"messageCode": "WARN-104",
"messageText": "El número de teléfono 55 21 123456789 es inválido"
},
{
"idMessage": null,
"idAviso": 3018371361,
"idInterfaceRun": null,
"messageType": "WARNING",
"messageCode": "WARN-0205",
"messageText": "El aviso no tiene caracteristicas secundarias"
}
],
"idAvisoPadre": null,
"codigoAvisoPadre": null,
"errors": [],
"error": false
}