BETA

POST /properties/verify

Mandás el objeto de una propiedad y te contestamos tres cosas:

  1. Si el objeto es válido según el contrato de Mapaprop, y qué le falta si no lo es.
  2. Qué entendimos de lo que mandaste — cuántos campos reconstruimos de tu arreglo attributes.
  3. Si cada portal lo podría publicar, y cuando no, exactamente qué le falta y de quién es el problema.

Este endpoint no crea, no modifica y no publica nada. No deja rastro. Es para que ajustes tu objeto antes de integrarte, tantas veces como quieras.

Está en beta. La forma de la respuesta puede cambiar mientras dure esta etapa. Los cambios se anuncian antes en esta página.

Para qué sirve

Integrarse a varios portales tiene un problema que aparece tarde: mandás un objeto que te parece completo, se publica, y recién ahí ves que el aviso salió sin precio, sin pileta o con el tipo equivocado — porque cada portal pide cosas distintas y se calla lo que no entiende.

Este endpoint te deja ver eso antes de publicar, sin crear nada y sin necesidad de tener las cuentas de los portales conectadas.

Resource information
AuthenticationRequerida (JWT) — scope property-api-verify
HTTP MethodPOST
ResponseJSON
Version1

Resource URL

https://property-api.mapaprop.com/property-v1/properties/verify

Autenticación

Se pide un token OAuth2 y el scope property-api-verify.

POST /property-v1/properties/verify
Host: property-api.mapaprop.com
Content-Type: application/json
Authorization: Bearer {access_token}

El token se obtiene como cualquier otro: POST /api/action/oauth2-v1/authorize.

Los scopes viajan firmados dentro del token. Si te agregamos un scope después de que generaste el tuyo, hay que generarlo de nuevo para que tome efecto — y generar uno nuevo invalida el anterior. Pedí de entrada todos los scopes que vayas a necesitar.

El cuerpo de la petición

El verify anda SIN haber declarado tu cliente. Es un probador: valida el token y describe el objeto, no da de alta nada. Si todavía no lo declaraste, rellena los datos del cliente con un placeholder, y te lo dice en customerSource — así podés probar el objeto el primer día, sin ningún paso previo y sin confundir el relleno con tus datos.

⚠️ Donde SÍ hace falta es en el alta: POST /property-v1/properties responde 400 con rule: account_required si la cuenta no tiene cliente declarado. Se declara UNA vez con POST /property-v1/customers. Las propiedades que cargues después la heredan; las ya cargadas conservan el contacto con el que se crearon.

⚠️ Un detalle del placeholder: el country no se rellena. Un valor de relleno ahí sería indistinguible de una respuesta real, y es el dato que no conviene adivinar.

{
  "canonical": { …el objeto de la propiedad… },
  "portals": ["argenprop", "zonaprop", "cabaprop"]
}
ClaveObligatorioQué es
canonicalsíEl objeto de la propiedad. Se acepta property como nombre alternativo
portalsnoQué portales evaluar. Si no lo mandás, se evalúan todos

El objeto que va en canonical es el mismo de siempre: El objeto JSON de la propiedad.

Si mandás un portal que no existe, la petición falla con un 400 en vez de ignorarlo en silencio.

Qué portales te reporta

Si en publication.api declarás…La respuesta trae…
Uno o varios portalessólo ésos
Nada (no mandás publication)todos

La idea es que no te lleguen problemas de un portal que no configuraste. Si ya declaraste Argenprop y nada más, Zonaprop no aparece en la respuesta ni cuenta en el summary.

Y si todavía no configuraste ninguno, los ves todos: es el caso de quien está evaluando la integración y quiere ver cómo se convierte su objeto en cada portal antes de decidir.

Si querés acotar la respuesta sin declarar la configuración, usá portals en el cuerpo de la petición. Son dos cosas distintas: portals dice qué querés mirar, publication dice qué tenés configurado.

publication — la configuración de publicación, dentro del objeto

Dentro de canonical podés mandar una clave publication con lo que cada portal necesita de tu cuenta y de tus elecciones de publicación. No es un campo de la propiedad: es cómo la publicás.

{
  "publication": {
    "api": {
      "argenprop": { "visible": true },
      "zonaprop": {
        "plan": { "plan": "SUPERDESTACADO" },
        "branch": { "custId": 1, "email": "contacto@ejemplo.com", "name": "Inmobiliaria", "phone1": "1144445555" }
      },
      "cabaprop": { "token": "<tu-token-de-cabaprop>" }
    }
  }
}

El branch de Zonaprop y el sellerContact de MercadoLibre los autocompletamos desde la cliente que declaraste: no hace falta mandarlos. Están en el ejemplo porque si los mandás, ganan — el autocompletado tiene la precedencia más baja de todas.

PortalCampos
argenpropadvertiserId (number) · visible (boolean)
zonapropplan (object) · branch (object)
cabapropbranchOfficeId (number)
mercadolibrelistingTypeId (string) · condition (string) · sellerContact (object)

Cada portal acepta además un token (string), que se valida de forma y nunca de validez: este endpoint no verifica cuentas. Su valor no aparece en ninguna parte de la respuesta.

publication no viaja a los portales como un campo más: se consume acá y se descarta.

La referencia completa —los dos niveles, qué pasa si mandás algo que no corresponde, y el detalle del token— está en su propia página: La clave publication.

La respuesta

La respuesta trae el clientRef, el mismo que mandaste en el sobre. Te lo devolvemos en los seis caminos (verify, alta, consulta, listado, edición y borrado) para que puedas cruzarlo con tu base sin tener que recordar con qué clientRef preguntaste.

{
  "mode": "client",
  "object": {
    "valid": true,
    "contract": [],
    "mapapropZone": "1-2-189-973",
    "conflicts": []
  },
  "portals": {
    "argenprop": {
      "status": "fields_complete",
      "connection": "not_verified",
      "zone": {
        "sent": {
          "code": "1-2-189-973",
          "level": 3
        },
        "publishingTo": "Mar del Plata",
        "status": "mapped"
      },
      "blockers": [],
      "pendingAtPublishTime": []
    },
    "zonaprop": {
      "status": "fields_complete",
      "connection": "not_verified",
      "zone": {
        "sent": {
          "code": "1-2-189-973",
          "level": 3
        },
        "publishingTo": "General Pueyrredón",
        "status": "mapped"
      },
      "blockers": [],
      "pendingAtPublishTime": []
    },
    "cabaprop": {
      "status": "fields_complete",
      "connection": "not_verified",
      "zone": {
        "sent": {
          "code": "1-2-189-973",
          "level": 3
        },
        "status": "not_mapped",
        "message": "Todavía no tenemos mapeada esta zona para cabaprop. Escribinos con el código de zona y la publicamos: el mapeo queda hecho para siempre."
      },
      "blockers": [],
      "pendingAtPublishTime": []
    },
    "mercadolibre": {
      "status": "coming_soon",
      "message": "MercadoLibre: disponible pronto. La integración todavía no está habilitada en este endpoint."
    }
  },
  "summary": {
    "complete": 3,
    "of": 4
  }
}

object — qué pasó con tu objeto

CampoQué dice
validSi el objeto cumple el contrato de Mapaprop
contractLo que no cumple: field, rule y el detalle. Vacío si valid es true
mapapropZoneLa zona que resolvimos, como zone0-zone1-zone2-zone3
conflictsCampos donde tu attributes contradice al campo suelto. Gana attributes

conflicts merece atención: si mandás "type": 23 y tu attributes dice "Departamento", se publica como Departamento. No es un error, es la regla — pero si no era lo que querías, lo ves acá en vez de en el aviso.

zone0, zone1, zone2 y zone3 no se miran sólo como números: se buscan en el catálogo de zonas, con su jerarquía. Una zone2 que existe pero cuelga de otra zone1 es tan inválida como una inventada.

{
  "field": "zone2",
  "rule": "not_found",
  "value": "1-1-999999-0",
  "detail": "la zona 1-1-999999-0 no existe en el catálogo de Mapaprop…"
}

El value es el código de 4 segmentos que armamos con tus cuatro números — el mismo formato del catálogo de zonas. Con ese código podés buscar la zona correcta sin bajarte el catálogo entero.

Por qué importa: una zona inexistente no rebota en ningún lado. La propiedad entra, no aparece en ninguna búsqueda por ubicación, y su URL se arma con un hueco en el medio. Es el tipo de error que no se nota hasta que alguien pregunta por qué no encuentra el aviso.

Si no mandaste zone2, no te decimos que la zona no existe: te decimos que falta el campo. Son dos problemas distintos y el mensaje lo distingue.

Si en algún momento no podemos leer el catálogo, no inventamos un error: la zona simplemente no se reporta. Un problema nuestro nunca va a aparecer como un dato malo tuyo.

Cada entrada del bag se busca en el catálogo del país de la propiedad. Hay dos clases de problema y se tratan distinto a propósito:

{ "field": "attributes[3].id", "rule": "unknown", "value": "metrosCuadrados",
  "detail": "el atributo \"metrosCuadrados\" no existe en el catálogo de este país. Se ignora…" }
Quérule¿valid: false?
el id no está en el catálogo de ese paísunknownno
el key_legacy o el valor no son los del catálogoattribute_valuesí

Por qué el primero no invalida: podés mandar tu propio bag enriquecido con datos que te sirven a vos. Te avisamos cuál no vamos a usar, pero no te marcamos el objeto como inválido por un dato que no es un error.

Y por qué igual se reporta: un id que no existe se ignora en silencio, así que esa característica no llega a ningún portal — y mirando la propiedad no se nota.

El catálogo cambia según el país. Los juegos de claves son subconjuntos entre sí: un atributo que existe en Argentina puede no existir en Paraguay. Lo pedís con el país de la propiedad en el catálogo de atributos.

portals — qué dice cada portal

CampoQué dice
statusEl veredicto. Valores abajo
connectionconnected · not_connected · not_verified
zoneQué zona mandaste y en cuál vamos a publicar. Abajo
blockersLo que falta en el objeto para poder publicar
pendingAtPublishTimeLo que falta para publicar, pero no es del objeto (plan, sucursal, zona mapeada)
omittedDatos que mandaste bien y que ese portal no admite para ese tipo de propiedad. Abajo
adjustedLo que modificamos antes de mandarlo: un valor normalizado, o algo que decidimos no enviar. Abajo

Valores de status:

ValorSignifica
fields_completeEl objeto tiene todo lo que ese portal necesita
missing_dataFalta un dato. Mirá blockers — hay algo que vos podés arreglar
not_supportedEl portal no soporta algo de esta propiedad. No lo podés arreglar mandando más datos
coming_soonLa integración todavía no está habilitada en este endpoint

Algunos portales no pueden armar el aviso hasta tener su configuración: Zonaprop necesita el plan y los datos de la sucursal. En esos casos el portal aparece con su estado y sus pendingAtPublishTime — no porque tu objeto esté mal, sino porque todavía falta el dato de cuenta con el que se construye.

Los blockers que vienen de publication traen además cómo se arreglan, pegado al mensaje: para una elección de publicación es un ejemplo listo para pegar (se espera boolean · ejemplo: "publication": { "api": { "argenprop": { "visible": true } } }); para un dato de la cuenta de tu cliente es de dónde sale el valor real, porque ahí ningún ejemplo serviría. Ver La clave publication.

Cada blocker trae:

{ "field": "price",
  "kind": "missing",
  "message": "`price` es obligatorio en el objeto de Mapaprop y no vino…",
  "youCanFixIt": true }

youCanFixIt contesta la única pregunta que importa de un blocker: ¿esto lo arreglo yo mandando más datos, o es una limitación del portal? Si es true, mandá el dato. Si es false, ese portal no admite lo que le estás pidiendo y no hay JSON que lo resuelva.

blockers y pendingAtPublishTime son cosas distintas a propósito. Un objeto perfecto al que sólo le falta elegir el plan no es un objeto incompleto: es una publicación sin configurar. Por eso pendingAtPublishTime no afecta al status.

omitted — lo que mandaste y no llega al portal

Cada portal tiene un catálogo de características distinto para cada tipo de propiedad. Una cochera admite 19; un departamento, 80. Si cargaste "patio" en una cochera, es un dato correcto en Mapaprop que en el catálogo de cochera de ese portal no existe.

En ese caso hacemos dos cosas: no lo mandamos —si lo mandáramos el portal lo rechaza— y te lo decimos:

"omitted": [
  { "field": "attributes.hasPatio",
    "characteristicId": "1000114",
    "name": "AMBIENTES|PATIO",
    "reason": "Zonaprop no admite esta característica para el tipo 32, así que no viaja. El dato queda en Mapaprop; en el portal ese campo no existe para este tipo de propiedad." }
]
CampoQué es
fieldTu campo, con el nombre que vos usás. Es el que podés buscar en tu propio JSON
reasonPor qué no viaja, y qué pasa con el dato
characteristicId · nameCómo llama el portal a esa característica. Útil para hablar con su soporte

El dato no se pierde: queda guardado en Mapaprop. Lo que no ocurre es que llegue a ese portal. Si la misma propiedad se publica en otro que sí lo admita, va a viajar ahí.

Y por eso omitted no es una instrucción de sacar el campo. El objeto es el de Mapaprop, no el de un portal: te pedimos todos los datos porque es lo que nos permite publicar en todos los portales posibles. Un campo que un portal no usa sigue siendo necesario para los otros. Si lo quitás de tu objeto, perdés esa compatibilidad.

adjusted — lo que modificamos antes de mandarlo

omitted dice "esto no viajó". adjusted dice "esto viajó distinto", y son dos cosas distintas: un dato ausente no es un dato alterado.

CampoQué trae
fieldla clave de tu objeto que se vio afectada
reasonqué se cambió y por qué
"adjusted": [
  { "field": "development.units[1]",
    "reason": "La unidad U2 no se publica en Zonaprop porque está marcada `sold`. Sigue en tu desarrollo y cuenta para el total; el portal no tiene cómo mostrar una unidad no disponible, así que la mostraría como si estuviera a la venta." }
]

Los dos casos típicos: un valor que normalizamos para que el portal lo acepte (un título recortado a su máximo) y una decisión nuestra sobre lo que mandamos (una unidad que no viaja por su estado).

Nada que modificamos viaja en silencio. Si el payload sale distinto de lo que nos diste, está acá — con el campo y el motivo. Y lo ves en el verify, que no gasta cuota, antes de publicar.

Un ítem en adjusted tampoco es un error: es una decisión que tomamos por el contrato del portal. Lo que sí conviene es leerlo, porque a veces implica una acción tuya — por ejemplo, una unidad que se vendió después de publicarse hay que darle de baja su aviso: dejar de mandarla no la baja.

Un ítem en omitted no es un error y no hay nada que corregir: mandaste un atributo legítimo y ese portal no lo tiene para ese tipo. Está acá para que sepas qué no llegó, y lo ves en el verify —que no gasta cuota— antes de publicar.

Hoy lo devuelve Zonaprop. En los otros portales estamos separando dos cosas que su campo mezcla, y hasta que eso esté resuelto preferimos no mandarte una lista que signifique dos cosas a la vez.

zone — en qué zona vamos a publicar

Cada portal tiene su propio mapa de zonas, y nosotros mantenemos la traducción entre tu zona de Mapaprop y la de ese portal. zone te muestra las dos puntas:

{ "sent": { "code": "1-2-189-973", "level": 3 },
  "publishingTo": "Mar del Plata",
  "status": "mapped" }
CampoQué dice
sent.codeLa zona que mandaste, tal como la armamos con tus zone0…zone3
sent.levelHasta qué nivel llega ese código: 2 es el partido entero, 3 baja a la localidad
sent.nameEl nombre de tu zona, si mandaste la descripción del nivel correspondiente
publishingToEl nombre de la zona del portal donde va a salir tu aviso
statusmapped · not_mapped · not_sent · not_verified

Los estados:

ValorSignifica
mappedResolvimos la zona. publishingTo te dice dónde va a salir
not_mappedTu zona es válida, pero todavía no la tenemos mapeada a ese portal. Trae un message con qué hacer
not_sentNo mandaste la zona en el objeto
not_verifiedNo llegamos a consultar el mapeo, así que no afirmamos nada

Mirá publishingTo aunque el estado sea mapped. Es el nombre público de la zona del portal: si mandaste una zona y ahí aparece otra, el aviso va a salir en ese otro lugar. Escribinos y lo corregimos — sos el único que puede darse cuenta, porque sos el que conoce la propiedad.

Un 0 al final del código no significa que falte un nivel: 1-2-201-0 es el partido entero, y es un destino de publicación válido por sí mismo. Por eso level cuenta hasta el último número distinto de cero.

summary

{ "summary": { "complete": 3, "of": 4 } }

Cuántos portales tienen los obligatorios completos, sobre el total evaluado.

Los campos obligatorios de Mapaprop mandan sobre los del portal

Esto es lo más importante de entender del endpoint.

Mapaprop tiene su propio contrato de campos obligatorios, y no depende de lo que pida cada portal. Si falta uno de esos campos, ningún portal queda en fields_complete — aunque ese portal en particular no lo exija.

Ejemplo: Argenprop no exige el precio para armar su aviso. Igual, si no mandás price:

{
  "object": {
    "valid": false,
    "contract": [ { "field": "price", "rule": "required", "detail": "" } ]
  },
  "portals": {
    "argenprop": {
      "status": "missing_data",
      "blockers": [
        { "field": "price",
          "kind": "missing",
          "message": "`price` es obligatorio en el objeto de Mapaprop y no vino. Sin él no se publica en ningún portal, lo exija o no este portal en particular.",
          "youCanFixIt": true }
      ]
    }
  },
  "summary": { "complete": 0, "of": 4 }
}

La lista completa de campos obligatorios está en El objeto JSON de la propiedad.

Sólo la ausencia de un obligatorio bloquea. Un campo presente pero con un formato incorrecto aparece en object.contract e informa sin bloquear — para que puedas ir corrigiendo sin que el endpoint se vuelva inusable. Revisá siempre object.contract, no sólo el summary.

No hace falta tener el portal conectado

El campo connection te dice si la cuenta de ese portal está conectada, pero no condiciona nada: el objeto se mapea igual y los blockers se calculan igual.

ValorSignifica
connectedLa cuenta está conectada
not_connectedNo hay cuenta conectada para ese portal
not_verifiedNo se pudo verificar el estado de la conexión

Es un dato al costado, y sigue importando: un objeto impecable no se publica si la cuenta no está conectada. Pero para perfeccionar tu objeto no necesitás tener ninguna.

Errores

CódigoCuándo
400Falta el body, no es JSON válido, falta canonical/property, o pediste un portal que no existe. ⚠️ El verify NO da 400 por no tener cliente declarado — eso es del alta; acá se simula con un placeholder
403Al token le falta el scope property-api-verify
{
  "error": "unknown_portal",
  "detail": "Portales desconocidos: idealista. Válidos: mapaprop, argenprop, zonaprop, cabaprop, mercadolibre, buscadorprop",
  "field": "portals"
}

MercadoLibre

Sale siempre como coming_soon. La integración existe pero todavía no está habilitada en este endpoint, y preferimos no mostrarte un mapeo sin verificar: lo tomarías por bueno.

Cómo usarlo

  1. Mandá tu objeto tal como lo tenés hoy.
  2. Mirá primero object.valid y object.contract. Si hay un obligatorio faltando, arreglá eso — va a estar bloqueando todos los portales a la vez.
  3. Mirá object.conflicts. Si aparece algo, tu attributes y tus campos sueltos se están contradiciendo, y gana attributes.
  4. Portal por portal, resolvé los blockers con youCanFixIt: true.
  5. Los youCanFixIt: false no los podés resolver: son límites del portal.
  6. Repetí. No se crea nada, así que probá tantas veces como necesites.

¿Necesitás ayuda? Contactá al Soporte técnico de Mapaprop