Resumen de endpoints
La tabla siguiente refleja las rutas públicas montadas en backend-public-api/app.js. Las rutas se muestran con el prefijo del proxy público utilizado por las integraciones externas.
| Método | Endpoint | Descripción | Acceso |
|---|---|---|---|
GET | /public-api/healthz | Comprobación del estado del servicio. | público |
GET | /public-api/v1/auth/check | Valida las credenciales y devuelve la tienda, los ámbitos y las funciones del plan. | cualquier credencial autenticada |
GET | /public-api/v1/customer-orders | Devuelve una lista paginada y filtrable de pedidos de clientes. | orders:read |
GET | /public-api/v1/customer-orders/:id | Devuelve un pedido de cliente con los artículos de producto configurados. | orders:read |
POST | /public-api/v1/customer-orders/batch | Devuelve hasta 100 pedidos por ID. | orders:read |
PATCH | /public-api/v1/customer-orders/:id/status | Actualiza el estado del pedido. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity | Actualiza las cantidades de las líneas seleccionadas del pedido. | orders:write |
PATCH | /public-api/v1/customer-orders/:orderId/quantity/all | Establece una cantidad para todos los artículos de un pedido. | orders:write |
DELETE | /public-api/v1/customer-orders/:id | Elimina un pedido de cliente que pertenece al propietario de la tienda. | orders:write |
GET | /public-api/v1/products | Devuelve productos/diseños de la tienda con disponibilidad de integración y URL multimedia. | products:read |
GET | /public-api/v1/products/:id | Devuelve un producto/diseño de la tienda. | products:read |
POST | /public-api/v1/embed/session | Emite un JWT de corta duración para las herramientas integradas, incluido el generador de modelos. | embed:session:create |
GET | /public-api/v1/runtime/bootstrap | Resuelve el contexto de ejecución a partir de un JWT de integración. | token de integración Bearer |
GET | /public-api/v1/assets | Lista los elementos del catálogo de recursos del tipo solicitado. | cualquier credencial autenticada |
GET | /public-api/v1/assets/:type/:assetId | Devuelve un manifiesto del recurso con las funciones de archivo descargables. | cualquier credencial autenticada |
GET | /public-api/v1/assets/:type/:assetId/files/:role | Descarga un archivo de recurso según su función. | cualquier credencial autenticada |
GET | /public-api/v1/design-imports | Lista los diseños importables alojados en Alter. | credencial autenticada, se requiere plan Business |
GET | /public-api/v1/design-imports/:id | Devuelve la carga útil de importación de un diseño y los descriptores de archivos. | credencial autenticada, se requiere plan Business |
GET | /public-api/v1/design-imports/:id/files/:fileId | Descarga un archivo a partir del descriptor de importación de un diseño. | credencial autenticada, se requiere plan Business |
GET | /public-api/v1/file/public/products/:productId/:size | Devuelve una vista previa pública del producto. El tamaño debe ser small.png, medium.png o big.png. | público |
GET | /public-api/v1/file/protected/:key | Devuelve un archivo protegido mediante su clave de almacenamiento. | URL firmada o files:read |
GET | /public-api/v1/fonts | Devuelve todas las fuentes disponibles. | público |
GET | /public-api/v1/currencies | Devuelve todas las monedas. | público |
POST | /public-api/v1/runtime-bindings/sync-from-wordpress | Crea o actualiza vinculaciones de herramientas a partir de las correspondencias de productos de WordPress. | cualquier credencial autenticada |
PATCH | /public-api/v1/runtime-bindings/:id | Modifica una vinculación de herramienta. | cualquier credencial autenticada |
POST | /public-api/v1/runtime-bindings/:id/activate | Activa una vinculación de herramienta. | cualquier credencial autenticada |
POST | /public-api/v1/runtime-bindings/:id/deactivate | Desactiva una vinculación de herramienta. | cualquier credencial autenticada |
POST | /public-api/v1/wp-connect/exchange | Intercambia un código de transferencia de conexión automática de WordPress por credenciales API. | código de transferencia de un solo uso |
GET | /public-api/v1/model-generator/catalog | Lista los productos del generador, las configuraciones y las revisiones de plantillas visibles. | embed:session:create |
GET | /public-api/v1/model-generator/models | Lista modelos con descriptores de fuentes del generador fijados a revisiones concretas para su importación. | embed:session:create |
GET | /public-api/v1/model-generator/designer-catalog | Devuelve el catálogo de modelos del generador utilizado por Designer. | embed:session:create |
GET | /public-api/v1/model-generator/projects | Lista los proyectos del generador del propietario y los disponibles globalmente. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId | Devuelve la revisión más reciente o seleccionada del proyecto, la plantilla y el manifiesto de archivos. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/revisions/:revision | Devuelve la revisión más reciente o seleccionada del proyecto, la plantilla y el manifiesto de archivos. | embed:session:create |
GET | /public-api/v1/model-generator/projects/:projectId/artifacts/:artifactId | Descarga un artefacto tras comprobar el acceso a su proyecto. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/template | Devuelve un documento de plantilla accesible para la revisión de configuración seleccionada. | embed:session:create |
GET | /public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/import | Devuelve el paquete de importación de la plantilla con los archivos de dependencias. | embed:session:create |
GET | /public-api/v1/model-generator/mannequins | Devuelve ambos maniquíes y los descriptores de sus recursos. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets | Lista los recursos de las bibliotecas de texturas o fondos con archivos importables. | embed:session:create |
GET | /public-api/v1/model-generator/image-libraries/:kind/assets/:assetId | Devuelve un recurso de textura o fondo con sus archivos importables. | embed:session:create |
GET | /public-api/v1/model-generator/public-files/:key | Descarga un archivo de dependencia permitido del generador. | embed:session:create |