Documentación API

Misma identidad y RBAC

Login/registro usan users_app. Para datos de edificio envía el JWT Comunidesk en x-comunidesk-user-authorization; el backend aplica el RBAC por edificio.

# OAuth app (cuotas / scopes del gateway)
Authorization: Bearer <oauth_access_token>

# Identidad Comunidesk (RBAC por edificio)
x-comunidesk-user-authorization: Bearer <users_app_jwt>

curl -X POST https://gateway.comunidesk.com/oauth/token \
  -u CLIENT_ID:CLIENT_SECRET \
  -d grant_type=client_credentials \
  -d scope="comunidesk:read comunidesk:write"

Entornos

Envía el header x-comunidesk-environment para enrutar la petición al backend del entorno (dev, rnd, stg, uat, qa, prod).

• dev Development — Pruebas locales / sandbox del integrador
• rnd R&D — Experimentos y spikes
• stg Staging — Pre-producción integrada
• uat UAT — Aceptación de usuario
• qa QA — Validación de calidad
• prod Production — Datos reales de la cuenta

x-comunidesk-environment: stg

En entornos no-prod, prefija nombres de datos de prueba (p. ej. [STG] Mi edificio).

Protocolos

Elige el estilo de integración de tu stack. La taxonomía de entidades es la misma en REST, SOAP, GraphQL y OData.

• REST · /v1/rest/{EntitySet}
• SOAP · POST /v1/soap
• GraphQL · POST /v1/graphql
• OData v4 · /odata/v4/{EntitySet}?$filter=&$select=&$top=

Módulos

Módulos y productos del gateway.

• protocols Protocolos de integración REST, SOAP, GraphQL u OData sobre los mismos módulos Comunidesk.
• Módulo Edificios Catálogo de edificios y configuración de cobro. /v1/rest/Edificios
• Módulo Departamentos / Unidades Unidades del edificio: departamento, bodega o estacionamiento. /v1/rest/Departamentos
• Módulo Egresos Egresos y cuentas por pagar de la comunidad. /v1/rest/Egresos
• Módulo Gastos comunes Periodos de gasto común y prorrateo por unidad. /v1/rest/GastosComunes
• Módulo Pagos (gasto común) Pagos de gasto común por departamento. /v1/rest/Pagos
• Módulo Ingresos (tesorería) Ingresos de tesorería del edificio. /v1/rest/Ingresos
• Módulo Empleados Personal del edificio. /v1/rest/Empleados
• Módulo Proveedores Proveedores y contactos del edificio. /v1/rest/Proveedores
• Módulo Consumos Lecturas de luz, agua y gas por periodo. /v1/rest/Consumos
• Módulo Mantenciones Solicitudes y tickets de mantención. /v1/rest/Mantenciones
• Módulo Multas Multas aplicadas por departamento. /v1/rest/Multas
• Módulo Visitas / Encomiendas Registro de visitas y encomiendas. /v1/rest/Visitas
• Módulo Áreas comunes Áreas comunes reservables del edificio. /v1/rest/AreasComunes
• Módulo Reservas Reservas de áreas comunes. /v1/rest/Reservas
• Módulo Reglamentos Reglamentos internos de la comunidad. /v1/rest/Reglamentos
• Módulo Documentos legales Documentos legales del edificio. /v1/rest/DocumentosLegales
• Módulo Diario mural Anuncios del diario mural. /v1/rest/Anuncios
• Módulo Comunicaciones Comunicaciones enviadas a residentes. /v1/rest/Comunicaciones
• Módulo Tickets Tickets de soporte y atención. /v1/rest/Tickets
• Módulo Votaciones Votaciones y asambleas de la comunidad. /v1/rest/Votaciones
• Módulo Convenios de pago Convenios de pago por deuda. /v1/rest/Convenios
• Módulo Cotizaciones Cotizaciones de proveedores. /v1/rest/Cotizaciones
• Módulo Grupos de unidades Grupos de unidades para prorrateo o cobro. /v1/rest/GruposUnidades
• Módulo Inventario Inventario de bienes del edificio. /v1/rest/Inventario
• Módulo Aprobaciones Solicitudes de aprobación internas. /v1/rest/Aprobaciones
• Módulo Seguros Seguros por departamento. /v1/rest/Seguros
• Módulo Siniestros Siniestros y reclamos de seguros. /v1/rest/Siniestros
• Módulo Plan de emergencia Planes de emergencia del edificio. /v1/rest/PlanEmergencia
• Módulo Procedimientos Procedimientos internos operativos. /v1/rest/Procedimientos
• Módulo Pagos tesorería Pagos de tesorería del edificio. /v1/rest/PagosTesoreria
• Módulo Fondos de reserva Fondos de reserva de la comunidad. /v1/rest/FondosReserva
• files Files (PDF / Excel) Extracción de PDF y parseo de Excel con autenticación y límites de uso.
• ai Modelos de IA Modelos de IA del gateway con scopes y cuotas dedicadas.

Lab y Shell

El Lab (estilo Postman) y el Comunidesk Shell (barra inferior) permiten probar el gateway contra entornos controlados.

• Lab — colecciones, variables y entornos.
• Abre el Shell con el icono Terminal del header: help, env, get, token set.