Referencia de API
Cómo crear, leer y actualizar datos en Pfikus AI desde sistemas externos mediante claves de API con permisos por ámbito.
Pfikus AI expone una API REST para que sistemas externos puedan integrarse con la plataforma. El acceso se autentica con claves de API de organización y se controla mediante permisos por ámbito (scopes).
Claves de API de organización
Cada organización puede emitir sus propias claves de API:
- Se almacenan con hash SHA‑256 (nunca en texto plano) y se identifican por un prefijo.
- Tienen ámbitos que limitan lo que la clave puede hacer (p. ej.
properties:read,properties:write). - Admiten fecha de caducidad.
Guarda la clave en el momento de crearla: por seguridad no se vuelve a mostrar completa.
Property Hub Webhook API
La API del Property Hub permite crear, leer, actualizar y eliminar propiedades desde sistemas externos:
- Autenticación por clave de API.
- Autorización por ámbito:
properties:readyproperties:write. - Pensada para sincronizar portales, CRMs e importadores con tu catálogo de propiedades.
Referencia OpenAPI generada
La documentación de endpoints puede generarse automáticamente a partir de una especificación OpenAPI y publicarse como una sección navegable dentro de esta referencia.
La generación está cableada mediante npm run generate:docs. Actualmente se incluye una
especificación de ejemplo; sustitúyela por la especificación OpenAPI propia de Pfikus para
publicar la referencia de endpoints definitiva.