API · stage-images

stage-images operations in the OpenAPI contract that accept an API key.

Updated:

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.

  • Authentication: API key or dashboard session
  • Scopes: settings:write, flows:write

Request body (required)

  • image/png: string
  • image/jpeg: string
  • image/webp: string

Responses

StatusDescription
201Imagen guardada y auditada (flow.stage_image_uploaded) (StageImageOut)
401Error (RFC 9457) (Problem)
403Error (RFC 9457) (Problem)
413Error (RFC 9457) (Problem)
422Error (RFC 9457) (Problem)
429Error (RFC 9457) (Problem)
503Error (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.

  • Authentication: API key or dashboard session
  • Scopes: config:read

Parameters

NameInRequiredTypeDescription
idpathYesstring

Responses

StatusDescription
200Bytes de la imagen (image/jpeg o image/png) (string)
304Sin cambios (If-None-Match)
401Error (RFC 9457) (Problem)
403Error (RFC 9457) (Problem)
404Error (RFC 9457) (Problem)
503Error (RFC 9457) (Problem)