API reference
Integrá Orkasa
con tu stack.
REST API completa, webhooks en tiempo real, OAuth 2.0 para portales. Versionado semántico, rate limit generoso, contratos estables.
Autenticación
Generá API keys desde Configuración → API. Cada key tiene scopes (read, write, admin) y un brokerage_id asociado.
curl https://api.orkasa.io/v1/properties \
-H "Authorization: Bearer ork_live_xxxxxxxxxxxxx" \
-H "Content-Type: application/json"Endpoints
- GETListar propiedades del brokerage. Soporta filtros por status, type, precio.
/v1/properties - POSTCrear una nueva propiedad. Devuelve la URL pública para carga de imágenes.
/v1/properties - GETObtener una propiedad por ID con todos sus campos e imágenes.
/v1/properties/{id} - PATCHActualizar una propiedad parcialmente.
/v1/properties/{id} - POSTDisparar publicación a portales seleccionados con adapter spec.
/v1/properties/{id}/publish - GETListar leads con scoring, status y agente asignado.
/v1/leads - POSTCrear lead (uso típico: integración con tu sitio web).
/v1/leads - PATCHMover entre estados del kanban, cambiar asignación.
/v1/leads/{id} - POSTDisparar review de listing con Claude Opus 4.7. Devuelve 3 variantes + análisis de fotos.
/v1/ai/listing-review - POSTMejorar foto con Gemini 2.5 Flash Image. Devuelve URL del resultado.
/v1/ai/photo-enhance - GETEstado de cada integración (portal/social) del brokerage.
/v1/integrations
Webhooks
Eventos firmados con HMAC-SHA256 vía header X-Orkasa-Signature. Reintentos exponenciales con cap a 24h. Idempotencia vía event_id.
property.createdNueva propiedad creada.
property.updatedPropiedad modificada (incluye campo cambiado).
property.publishedPropiedad publicada en un portal específico.
property.unpublishedPropiedad despublicada o eliminada de un portal.
lead.createdNuevo lead capturado (incluye source).
lead.qualifiedLead pasó a calificado.
lead.assignedLead reasignado a otro agente.
compliance.kyc_requiredLead requiere KYC para avanzar.
compliance.match_alertMatch positivo en lista de sanciones.
Rate limits y SLA
Solo / Team
300 req/min
Brokerage
3,000 req/min
Uptime
99.9% (Brokerage SLA)