Escrituras y comprobación de resultados
En esta página
Previsualiza los cambios, escribe de forma deliberada y recupera un resultado incierto.
Operaciones REST y permisos de las claves
| Tarea | Permisos de la clave | Empieza aquí |
|---|---|---|
| Previsualizar y confirmar inmuebles y unidades | write:properties; read:properties para consultar el resultado | POST /api/v1/landlord/portfolio-imports/preview |
| Consultar o importar cuadros de rentas comerciales | read:rent-roll; write:rent-roll para importar | GET /api/v1/landlord/rent-roll |
Previsualiza, inspecciona, confirma y consulta el resultado
Empieza con la importación de cartera existente en dos pasos: crea una previsualización inmutable, comprueba su validez y los problemas que impiden continuar, y luego confirma esa previsualización con {"confirm":true}. Consulta GET /api/v1/landlord/portfolio-imports/{importId} para verificar el resultado persistente. Crear una previsualización también guarda datos y requiere permiso de escritura.
Mantén una única identidad para cada escritura
Cada modificación del arrendador requiere un Idempotency-Key de entre 16 y 200 caracteres, formado únicamente por letras ASCII, números, puntos, guiones bajos, dos puntos o guiones, sin espacios al principio ni al final. Crea una clave por operación lógica y conserva exactamente el cuerpo de la solicitud y la clave. Usa claves distintas para la previsualización y su confirmación. Las respuestas correctas tienen una ventana de repetición de 24 horas, limitada a la misma clave API y operación.
Recupera una escritura de resultado desconocido
Tras perder una respuesta, consulta el recurso o la operación si conoces el ID devuelto. Si no conoces ningún ID devuelto, repite la solicitud idéntica con el Idempotency-Key original y la clave API original dentro de las 24 horas siguientes al primer intento. Si esa ventana ha vencido o no hay una consulta o repetición segura disponible, detente y determina el resultado; ni reutilizar una clave caducada ni elegir una nueva garantiza que la escritura no vuelva a ejecutarse. Las previsualizaciones de importación, los trabajos y su historial siguen vinculados a la clave que los creó.
Conserva las capacidades de la solicitud
El envío versionado de solicitudes tiene un contrato diferente: conserva su UUID X-Application-Submission-Key, así como las claves de recibo y carga. Sigue las operaciones publicadas de recibo y progreso antes de repetir. El Idempotency-Key del arrendador no sustituye esas capacidades.
Usa la versión publicada del contrato
Usa la versión de API y el ciclo de vida indicados en la referencia, los esquemas de cada operación y cualquier versión de formulario o recurso requerida al actualizar una integración. Conserva las versiones opacas sin cambios y fija una versión MCP aprobada. Los nombres de evento proceden del mismo catálogo que la API; el orden de llegada y una versión de producto no sustituyen la consulta actual del recurso.