Saltar al contenido principal
Version: v1.0.0

Inicio rápido

Guía paso a paso para integrar su CRM con Spot2 Ingestion.


Requisitos previos

Antes de empezar, asegúrese de tener:

  • Un endpoint REST que exponga sus propiedades en JSON.
  • Su endpoint debe soportar el parámetro updated_since (filtro por fecha de modificación).
  • Un endpoint REST que exponga los IDs de propiedades eliminadas.
  • Capacidad de agregar autenticación (API key, bearer token, o header custom).
  • Paginación offset-based implementada.
  • Propiedades comerciales (no residenciales).

Paso 1 — Construya su endpoint

Cree un endpoint GET que devuelva sus propiedades activas en JSON:

GET https://su-crm.com/api/v1/spot2/properties?updated_since=2026-07-01T00:00:00Z

Requisitos mínimos:

  • Content-Type: application/json.
  • Autenticación: x-api-key o Authorization: Bearer.
  • Paginación: offset con meta.next en la respuesta.
  • Cada propiedad debe incluir al menos estos campos:
    • external_id — su identificador único e inmutable.
    • property_type — uno de: oficina, local, bodega, nave_industrial, terreno, edificio, local_en_centro_comercial.
    • modalityrent, sale o rent_and_sale.
    • price.rent_price o price.sale_price — al menos un precio mayor a 0.
    • price.currency — código ISO 4217 (default MXN).
    • location.city — ciudad.
    • location.state — estado.
    • updated_at — fecha de última modificación en ISO 8601.

Opcional pero muy recomendado:

  • photos — al menos 1 URL de foto.
  • location.latitude y location.longitude — coordenadas.
  • agent.email o agent.phone — contacto del agente.

El detalle completo de campos, tipos, validaciones y ejemplos está en Esquema de propiedad.


Paso 2 — (Opcional) Arme su webhook

Si quiere recibir notificaciones cuando una propiedad se publica o es rechazada, exponga un endpoint POST:

POST https://su-crm.com/api/webhooks/spot2/feedback

Recibirá:

  • item_accepted: la propiedad se publicó correctamente.
  • item_rejected: la propiedad fue rechazada (incluye messages con los motivos en lenguaje natural).

Si no configura el webhook, sus propiedades se publican igual pero no recibe notificaciones de errores.

El contrato completo del webhook está en Webhook de retroalimentación.


Paso 3 — Implemente eliminación

Exponga un endpoint que devuelva los IDs de propiedades eliminadas de su CRM:

GET https://su-crm.com/api/v1/spot2/properties/deleted

Este endpoint es obligatorio. Spot2 lo consulta en cada ciclo para detectar bajas y desactivar propiedades. Sin este endpoint, las propiedades eliminadas de su CRM seguirán publicadas en Spot2.

Detalles en Protocolo de eliminación.


Resumen de entregables

#Qué necesitaObligatorioDoc de referencia
1Endpoint GET de propiedades (con updated_since)Protocolo de sincronización + Esquema de propiedad
2Endpoint POST de webhookNoWebhook de retroalimentación
3Endpoint GET de eliminados (con since)Protocolo de eliminación

Próxima lectura