API · stage-images
Operaciones de stage-images del contrato OpenAPI que aceptan una clave de API.
Actualizado:
Imágenes de fondo de «Marcar sobre imagen» (FIU-661). Son del negocio de la credencial; el ítem sketch guarda solo el id.
POST /stage-images
Subir una imagen de fondo para «Marcar sobre imagen»
PNG/JPEG/WebP real (tipo verificado por bytes), máximo 2 MiB y 16 megapíxeles; se re-encoda sin metadatos y con 1600 px de lado como mucho (conserva la transparencia). Devuelve el id que va en sketch_background del ítem sketch; la imagen es del negocio de la credencial y no se publica hasta guardar el flujo. Permiso flows:write o scope settings:write. 30 subidas por minuto por negocio.
- Autenticación: Clave de API o sesión del panel
- Scopes:
settings:write,flows:write
Cuerpo de la solicitud (obligatorio)
image/png: stringimage/jpeg: stringimage/webp: string
Respuestas
| Estado | Descripción |
|---|---|
201 | Imagen guardada y auditada (flow.stage_image_uploaded) (StageImageOut) |
401 | Error (RFC 9457) (Problem) |
403 | Error (RFC 9457) (Problem) |
413 | Error (RFC 9457) (Problem) |
422 | Error (RFC 9457) (Problem) |
429 | Error (RFC 9457) (Problem) |
503 | Error (RFC 9457) (Problem) |
GET /stage-images/{id}
Descargar una imagen de fondo de «Marcar sobre imagen»
La lee quien completa etapas, con la cache privada y ETag. El id de otro negocio responde 404 stage_image_not_found. Permiso flows:stage_image_read o scope config:read.
- Autenticación: Clave de API o sesión del panel
- Scopes:
config:read
Parámetros
| Nombre | En | Obligatorio | Tipo | Descripción |
|---|---|---|---|---|
id | path | Sí | string |
Respuestas
| Estado | Descripción |
|---|---|
200 | Bytes de la imagen (image/jpeg o image/png) (string) |
304 | Sin cambios (If-None-Match) |
401 | Error (RFC 9457) (Problem) |
403 | Error (RFC 9457) (Problem) |
404 | Error (RFC 9457) (Problem) |
503 | Error (RFC 9457) (Problem) |