Utilidades +
Este endpoint agrupa una serie de recursos útiles y necesarios para la creación o consulta de información. Entre ellos se puede consultar el listado de países, idiomas, estados de pedidos o subir una imagen.
</> GET / util/filters/{targetType}/{id}Devuelve los filtros asignados al elemento indicado.
</> POST / util/filters/{targetType}/{id}Añade un filtro al elemento indicado.
</> DELETE / util/filters/{targetType}/{id}Elimina los filtros para el elemento indicado.
</> GET / util/filters/{targetType}/{itemType}/{itemId}Devuelve el identificador de los elementos que coinciden con el filtro especificado para el targetType indicado.
</> GET / util/filters/{targetType}/{id}/{itemType}/{itemId}Devuelve el elemento de filtro especificado para el targetType indicado.
</> DELETE / util/filters/{targetType}/items/{id}Elimina el filtro con el identificador especificado.
</> GET / util/orderStatusDevuelve los estados y sub-estados de pedido existentes.
</> GET / util/rmaStatusDevuelve los estados y sub-estados de RMA existentes.
</> GET / util/shipmentStatusDevuelve los estados y sub-estados de expedición existentes.
</> POST / util/uploadImageSube imágenes vía FTP al servidor de recursos estáticos.
GET /util/filters/{targetType}/{id}
Descripción
Devuelve los filtros asignados al elemento indicado.
Los tipos de filtro devueltos (itemType) son: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/1
Parámetros de entrada URL
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador del elemento.
targetType
Obligatoriostring
Tipo de elemento.
Valores permitidos: areas, banners, blogCategories, blogPost, bundles, categories, discounts, priceList, definitions, news, pages, paymentSystems, rewardPoints, shippingTypes, relatedDefinitions
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS": [
{
"ID" : 123,
"ITEM": {
"ID" : 1,
"PID" :"abc"
},
"ITEMTYPE" : 10
}
]
}
POST /util/filters/{targetType}/{id}
Descripción
Añade un filtro al elemento indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/1
Parámetros de entrada URL
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador del elemento.
targetType
Obligatorioselect
Tipo de elemento.
Valores permitidos: areas, banners, blogCategories, blogPost, bundles, categories, discounts, priceList, definitions, news, pages, paymentSystems, rewardPoints, shippingTypes, relatedDefinitions
Parámetros de entrada JSON
{
"items": {
"item": {
"id":numeric,
"pId":string
},
"itemType":string
}
}
Variables JSON:
VariableR/OValor por defectoTipo
items
Obligatoriostruct
Bloque de filtro a añadir
items/item
Obligatoriostruct
Bloque que define el identificador de filtro.
items/item/id
Opcional0numeric
Identificador interno del elemento que filtra.
En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 numeric.
Opcional en caso que se use identificador público (si lo tiene, en caso contrario es obligatorio).
items/item/pId
Opcionalstring
Identificador público del elemento que filtra (si lo tiene).
En caso que itemType sea 30, es el identificador del país en formato ISO 3166-1 alpha-2.
Opcional en caso que se use identificador interno.
items/itemType
Obligatoriostring
Tipo de filtro.
Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 123,
"ITEM": {
"ID" : 1,
"PID" :"abc"
},
"ITEMTYPE" : 10
}
DELETE /util/filters/{targetType}/{id}
Descripción
Elimina los filtros para el elemento indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/1
Parámetros de entrada URL
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador del elemento.
targetType
Obligatoriostring
Tipo de elemento.
Valores permitidos: areas, banners, blogCategories, blogPost, bundles, categories, discounts, priceList, definitions, news, pages, paymentSystems, rewardPoints, shippingTypes, relatedDefinitions
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS": [
]
}
GET /util/filters/{targetType}/{itemType}/{itemId}
Descripción
Devuelve el identificador de los elementos que coinciden con el filtro especificado para el targetType indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/{itemType}/{itemId}
Parámetros de entrada URL
VariableR/OValor por defectoTipo
itemId
Obligatorionumeric
Identificador del elemento de filtro.
itemType
Obligatoriostring
Tipo de elemento de filtro.
Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países
targetType
Obligatoriostring
Tipo de elemento.
Valores permitidos: areas, banners, blogCategories, blogPost, bundles, categories, discounts, priceList, definitions, news, pages, paymentSystems, rewardPoints, shippingTypes, relatedDefinitions
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS": [
{
"ID" : 1,
"PID" :"abc"
}
]
}
GET /util/filters/{targetType}/{id}/{itemType}/{itemId}
Descripción
Devuelve el elemento de filtro especificado para el targetType indicado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/1/{itemType}/{itemId}
Parámetros de entrada URL
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador del elemento.
itemId
Obligatorionumeric
Identificador del elemento de filtro.
itemType
Obligatoriostring
Tipo de elemento de filtro.
Valores permitidos: 10 - Usuario, 11 - Grupo de usuario, 30 - Países, 9 - Zonas de países
targetType
Obligatoriostring
Tipo de elemento.
Valores permitidos: areas, banners, blogCategories, blogPost, bundles, categories, discounts, priceList, definitions, news, pages, paymentSystems, rewardPoints, shippingTypes, relatedDefinitions
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 123,
"ITEM": {
"ID" : 1,
"PID" :"abc"
},
"ITEMTYPE" : 10
}
DELETE /util/filters/{targetType}/items/{id}
Descripción
Elimina el filtro con el identificador especificado.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/items/1
Parámetros de entrada URL
VariableR/OValor por defectoTipo
id
Obligatorionumeric
Identificador interno del filtro
targetType
Obligatoriostring
Tipo de elemento.
Valores permitidos: areas, banners, blogCategories, blogPost, bundles, categories, discounts, priceList, definitions, news, pages, paymentSystems, rewardPoints, shippingTypes, relatedDefinitions
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ID" : 123
}
GET /util/filters/{targetType}/pId/{pId}
Descripción
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/pId/abc
Parámetros de entrada URL
VariableR/OValor por defectoTipo
pId
Obligatoriostring
Identificador público.
targetType
Obligatoriostring
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS": [
{
"ID" : 123,
"ITEM": {
"ID" : 1,
"PID" :"abc"
},
"ITEMTYPE" : 10
}
]
}
POST /util/filters/{targetType}/pId/{pId}
Descripción
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/pId/abc
Parámetros de entrada URL
VariableR/OValor por defectoTipo
pId
Obligatoriostring
Identificador público.
targetType
Obligatorioselect
Parámetros de entrada JSON
{
"items": {
"item": {
"id":numeric,
"pId":string
},
"itemType":string
}
}
Variables JSON:
VariableR/OValor por defectoTipo
itemsObligatoriostruct
items/itemObligatoriostruct
items/item/idOpcional0numeric
items/item/pIdOpcionalstring
items/itemTypeObligatoriostring
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"ID" : 123,
"ITEM": {
"ID" : 1,
"PID" :"abc"
},
"ITEMTYPE" : 10
}
DELETE /util/filters/{targetType}/pId/{pId}
Descripción
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/filters/{targetType}/pId/abc
Parámetros de entrada URL
VariableR/OValor por defectoTipo
pId
Obligatoriostring
Identificador público.
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"ITEMS": [
]
}
GET /util/orderStatus
Descripción
Devuelve los estados y sub-estados de pedido existentes. Los estados con identificador negativo se muestran con el símbolo “_” delante.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/orderStatus
Parámetros de entrada URL
VariableR/OValor por defectoTipo
language
Obligatoriostring
Devuelve elementos asociados al idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages.
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"states": [
{
"name" :"Incoming",
"state" :"1",
"subStates": [
{
"description" :"
"
,
"id" : 8,
"name" :"Test2",
"pId" : 8,
"publicName" :"Test2",
"subStates": [
]
},
{
"description" :"",
"id" : 13,
"name" :"Test",
"pId" : 13,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"In process",
"state" :"2",
"subStates": [
{
"description" :"",
"id" : 14,
"name" :"in process 2",
"pId" : 14,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"Incidents",
"state" :"0",
"subStates": [
]
},
{
"name" :"Fraudulent",
"state" :"_666",
"subStates": [
]
},
{
"name" :"Refund requests",
"state" :"_20",
"subStates": [
]
},
{
"name" :"Unfinished",
"state" :"_10",
"subStates": [
]
},
{
"name" :"Reservations",
"state" :"3",
"subStates": [
{
"description" :"",
"id" : 9,
"name" :"Reservations 2",
"pId" : 9,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"Completed",
"state" :"4",
"subStates": [
]
},
{
"name" :"Pending",
"state" :"5",
"subStates": [
]
},
{
"name" :"Deleted",
"state" :"6",
"subStates": [
]
},
{
"name" :"Refunds",
"state" :"20",
"subStates": [
{
"description" :"",
"id" : 10,
"name" :"Refunds 2",
"pId" : 10,
"publicName" :"Refunds 2",
"subStates": [
]
}
]
}
]
}
GET /util/rmaStatus
Descripción
Devuelve los estados y sub-estados de RMA existentes.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/rmaStatus
Parámetros de entrada URL
VariableR/OValor por defectoTipo
language
Obligatoriostring
Devuelve elementos asociados al idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages.
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"states": [
{
"name" :"Incoming",
"state" :"1",
"subStates": [
{
"description" :"
"
,
"id" : 8,
"name" :"Test2",
"pId" : 8,
"publicName" :"Test2",
"subStates": [
]
},
{
"description" :"",
"id" : 13,
"name" :"Test",
"pId" : 13,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"In process",
"state" :"2",
"subStates": [
{
"description" :"",
"id" : 14,
"name" :"in process 2",
"pId" : 14,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"Incidents",
"state" :"0",
"subStates": [
]
},
{
"name" :"Fraudulent",
"state" :"_666",
"subStates": [
]
},
{
"name" :"Refund requests",
"state" :"_20",
"subStates": [
]
},
{
"name" :"Unfinished",
"state" :"_10",
"subStates": [
]
},
{
"name" :"Reservations",
"state" :"3",
"subStates": [
{
"description" :"",
"id" : 9,
"name" :"Reservations 2",
"pId" : 9,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"Completed",
"state" :"4",
"subStates": [
]
},
{
"name" :"Pending",
"state" :"5",
"subStates": [
]
},
{
"name" :"Deleted",
"state" :"6",
"subStates": [
]
},
{
"name" :"Refunds",
"state" :"20",
"subStates": [
{
"description" :"",
"id" : 10,
"name" :"Refunds 2",
"pId" : 10,
"publicName" :"Refunds 2",
"subStates": [
]
}
]
}
]
}
GET /util/shipmentStatus
Descripción
Devuelve los estados y sub-estados de expedición existentes.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/shipmentStatus
Parámetros de entrada URL
VariableR/OValor por defectoTipo
language
Obligatoriostring
Devuelve elementos asociados al idioma. Formato ISO 639-1 de dos dígitos. Más información en el recurso: util/languages.
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"states": [
{
"name" :"Incoming",
"state" :"1",
"subStates": [
{
"description" :"
"
,
"id" : 8,
"name" :"Test2",
"pId" : 8,
"publicName" :"Test2",
"subStates": [
]
},
{
"description" :"",
"id" : 13,
"name" :"Test",
"pId" : 13,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"In process",
"state" :"2",
"subStates": [
{
"description" :"",
"id" : 14,
"name" :"in process 2",
"pId" : 14,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"Incidents",
"state" :"0",
"subStates": [
]
},
{
"name" :"Fraudulent",
"state" :"_666",
"subStates": [
]
},
{
"name" :"Refund requests",
"state" :"_20",
"subStates": [
]
},
{
"name" :"Unfinished",
"state" :"_10",
"subStates": [
]
},
{
"name" :"Reservations",
"state" :"3",
"subStates": [
{
"description" :"",
"id" : 9,
"name" :"Reservations 2",
"pId" : 9,
"publicName" :"",
"subStates": [
]
}
]
},
{
"name" :"Completed",
"state" :"4",
"subStates": [
]
},
{
"name" :"Pending",
"state" :"5",
"subStates": [
]
},
{
"name" :"Deleted",
"state" :"6",
"subStates": [
]
},
{
"name" :"Refunds",
"state" :"20",
"subStates": [
{
"description" :"",
"id" : 10,
"name" :"Refunds 2",
"pId" : 10,
"publicName" :"Refunds 2",
"subStates": [
]
}
]
}
]
}
POST /util/uploadImage
Descripción
Sube imágenes vía FTP al servidor de recursos estáticos.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/util/uploadImage
Parámetros de entrada JSON
{
"data": {
"autoDestination":boolean,
"createAdditionalLargeImage":boolean,
"createAdditionalSmallImage":boolean,
"createLargeImage":boolean,
"createMediumImage":boolean,
"createSmallImage":boolean,
"destination": {
"additionalLargeImageDestination":string,
"additionalSmallImageDestination":string,
"destination":string,
"largeImageDestination":string,
"mediumImageDestination":string,
"smallImageDestination":string
},
"image":string,
"main":boolean,
"name":string,
"overwrite":boolean,
"params": {
"additionalLargeImage": {
"flipHorizontally":boolean,
"flipVertically":boolean,
"forceSize":boolean,
"height":numeric,
"pattern":string,
"quality":numeric,
"resize":boolean,
"width":numeric
},
"additionalSmallImage": {
"flipHorizontally":boolean,
"flipVertically":boolean,
"forceSize":boolean,
"height":numeric,
"pattern":string,
"quality":numeric,
"resize":boolean,
"width":numeric
},
"largeImage": {
"flipHorizontally":boolean,
"flipVertically":boolean,
"forceSize":boolean,
"height":numeric,
"pattern":string,
"quality":numeric,
"resize":boolean,
"width":numeric
},
"mediumImage": {
"flipHorizontally":boolean,
"flipVertically":boolean,
"forceSize":boolean,
"height":numeric,
"pattern":string,
"quality":numeric,
"resize":boolean,
"width":numeric
},
"smallImage": {
"flipHorizontally":boolean,
"flipVertically":boolean,
"forceSize":boolean,
"height":numeric,
"pattern":string,
"quality":numeric,
"resize":boolean,
"width":numeric
}
}
}
}
Variables JSON:
VariableR/OValor por defectoTipo
data
Obligatoriostruct
Bloque de información de una imagen.
data/autoDestination
Opcionalfalseboolean
Permite escoger la ubicación de las imágenes resultantes.
Valores permitidos: true - Ubicación definida por defecto en el Backoffice. false - Ubicación manual. En este último caso, se deberán especificar la/s destinaciones de las imágenes resultantes. Véase el parámetro destination.
data/createAdditionalLargeImage
Opcionaltrueboolean
Indica si se desea crear la imagen adicional grande. Este parámetro solo tiene efecto si main=false.
data/createAdditionalSmallImage
Opcionaltrueboolean
Indica si se desea crear la imagen adicional pequeña. Este parámetro solo tiene efecto si main=false.
data/createLargeImage
Opcionaltrueboolean
Indica si se desea crear la imagen principal grande. Este parámetro solo tiene efecto si main=true
data/createMediumImage
Opcionaltrueboolean
Indica si se desea crear la imagen principal mediana. Este parámetro solo tiene efecto si main=true.
data/createSmallImage
Opcionaltrueboolean
Indica si se desea crear la imagen principal pequeña. Este parámetro solo tiene efecto si main=true.
data/destination
Opcionalstruct
Bloque de información sobre la ubicación de las imágenes creadas. Solo tiene efecto si autodestination=false.
data/destination/additionalLargeImageDestination
Opcionalstring
Ruta para la ubicación particular de la imagen adicional grande. Si no se informa, la imagen se ubicará en la ruta indicada en destination.
data/destination/additionalSmallImageDestination
Opcionalstring
Ruta para la ubicación particular de la imagen adicional pequeña. Si no se informa, la imagen se ubicará en la ruta indicada en destination.
data/destination/destination
Opcionalstring
Ruta para la ubicación general de las imágenes creadas.
data/destination/largeImageDestination
Opcionalstring
Ruta para la ubicación particular de la imagen principal grande. Si no se informa, la imagen se ubicará en la ruta indicada en destination.
data/destination/mediumImageDestination
Opcionalstring
Ruta para la ubicación particular de la imagen principal mediana. Si no se informa, la imagen se ubicará en la ruta indicada en destination.
data/destination/smallImageDestination
Opcionalstring
Ruta para la ubicación particular de la imagen principal pequeña. Si no se informa, la imagen se ubicará en la ruta indicada en destination.
data/image
Obligatoriostring
Imagen codificada en Base64
data/main
Obligatorioboolean
Indica el tipo de imagen a subir.
Valores permitidos: true - Imagen principal, false - Imagen adicional.
data/name
Obligatoriostring
Nombre de la imagen a crear.
data/overwrite
Opcionalfalseboolean
Indica cómo hay que actuar en caso de existir la imagen.
Valores permitidos: true - Sobrescribe la imagen, false - Renombra la imagen.
data/params
Opcionalstruct
Bloque de información de parámetros opcionales de las imágenes a generar. Cualquier parámetro no informado tomará el valor por defecto configurado en el Backoffice.
data/params/additionalLargeImage
Opcionalstruct
Bloque de parámetros para la imagen adicional grande.
data/params/additionalLargeImage/flipHorizontally
Opcionalfalseboolean
Invierte la imagen horizontalmente (eje X).
data/params/additionalLargeImage/flipVertically
Opcionalfalseboolean
Invierte la imagen verticalmente (eje Y).
data/params/additionalLargeImage/forceSize
Opcionalfalseboolean
Obliga a que las imágenes resultantes tengan las dimensiones exactas a las definidas en width y height. Este parámetro solo tiene efecto si resize=true.
data/params/additionalLargeImage/height
Opcionalnumeric
Píxeles totales entre el límite superior y el límite inferior de la imagen.
data/params/additionalLargeImage/pattern
Opcionalstring
Transforma el nombre de los archivos de imagen, una vez subidos, siguiendo un modelo de nomenclatura.
Ejemplos: Para el patrón '*_al' se le añadirá el sufijo '_al' a cualquier imagen.
data/params/additionalLargeImage/quality
Opcionalnumeric
Grado de degradación de la calidad de archivos '.jpg' en intervalos de 0.1 que equivalen a un 10% de degradación.
data/params/additionalLargeImage/resize
Opcionaltrueboolean
Cambia el ancho y el alto de la imagen para ajustarla a la width y/o height definida, conservando la proporcionalidad en el tamaño.
data/params/additionalLargeImage/width
Opcionalnumeric
Píxeles totales entre el límite izquierdo y el límite derecho de la imagen.
data/params/additionalSmallImage
Opcionalstruct
Bloque de parámetros opcionales para la imagen adicional pequeña.
data/params/additionalSmallImage/flipHorizontally
Opcionalfalseboolean
Invierte la imagen horizontalmente (eje X).
data/params/additionalSmallImage/flipVertically
Opcionalfalseboolean
Invierte la imagen verticalmente (eje Y).
data/params/additionalSmallImage/forceSize
Opcionalfalseboolean
Obliga a que las imágenes resultantes tengan las dimensiones exactas a las definidas en width y height. Este parámetro solo tiene efecto si resize=true.
data/params/additionalSmallImage/height
Opcionalnumeric
Píxeles totales entre el límite superior y el límite inferior de la imagen.
data/params/additionalSmallImage/pattern
Opcionalstring
Transforma el nombre de los archivos de imagen, una vez subidos, siguiendo un modelo de nomenclatura.
Ejemplos: Para el patrón '*_as' se le añadirá el sufijo '_as' a cualquier imagen.
data/params/additionalSmallImage/quality
Opcionalnumeric
Grado de degradación de la calidad de archivos '.jpg' en intervalos de 0.1 que equivalen a un 10% de degradación.
data/params/additionalSmallImage/resize
Opcionaltrueboolean
Cambia el ancho y el alto de la imagen para ajustarla a la width y/o height definida, conservando la proporcionalidad en el tamaño.
data/params/additionalSmallImage/width
Opcionalnumeric
Píxeles totales entre el límite izquierdo y el límite derecho de la imagen.
data/params/largeImage
Opcionalstruct
Bloque de parámetros opcionales para la imagen pequeña.
data/params/largeImage/flipHorizontally
Opcionalfalseboolean
Invierte la imagen horizontalmente (eje X).
data/params/largeImage/flipVertically
Opcionalfalseboolean
Invierte la imagen verticalmente (eje Y).
data/params/largeImage/forceSize
Opcionalfalseboolean
Obliga a que las imágenes resultantes tengan las dimensiones exactas a las definidas en width y height. Este parámetro solo tiene efecto si resize=true.
data/params/largeImage/height
Opcionalnumeric
Píxeles totales entre el límite superior y el límite inferior de la imagen.
data/params/largeImage/pattern
Opcionalstring
Transforma el nombre de los archivos de imagen, una vez subidos, siguiendo un modelo de nomenclatura.
Ejemplos: Para el patrón '*_l' se le añadirá el sufijo '_l' a cualquier imagen.
data/params/largeImage/quality
Opcionalnumeric
Grado de degradación de la calidad de archivos '.jpg' en intervalos de 0.1 que equivalen a un 10% de degradación.
data/params/largeImage/resize
Opcionaltrueboolean
Cambia el ancho y el alto de la imagen para ajustarla a la width y/o height definida, conservando la proporcionalidad en el tamaño.
data/params/largeImage/width
Opcionalnumeric
Píxeles totales entre el límite izquierdo y el límite derecho de la imagen.
data/params/mediumImage
Opcionalstruct
Bloque de parámetros opcionales para la imagen pequeña.
data/params/mediumImage/flipHorizontally
Opcionalfalseboolean
Invierte la imagen horizontalmente (eje X).
data/params/mediumImage/flipVertically
Opcionalfalseboolean
Invierte la imagen verticalmente (eje Y).
data/params/mediumImage/forceSize
Opcionalfalseboolean
Obliga a que las imágenes resultantes tengan las dimensiones exactas a las definidas en width y height. Este parámetro solo tiene efecto si resize=true.
data/params/mediumImage/height
Opcionalnumeric
Píxeles totales entre el límite superior y el límite inferior de la imagen.
data/params/mediumImage/pattern
Opcionalstring
Transforma el nombre de los archivos de imagen, una vez subidos, siguiendo un modelo de nomenclatura.
Ejemplos: Para el patrón '*_m' se le añadirá el sufijo '_m' a cualquier imagen.
data/params/mediumImage/quality
Opcionalnumeric
Grado de degradación de la calidad de archivos '.jpg' en intervalos de 0.1 que equivalen a un 10% de degradación.
data/params/mediumImage/resize
Opcionaltrueboolean
Cambia el ancho y el alto de la imagen para ajustarla a la width y/o height definida, conservando la proporcionalidad en el tamaño.
data/params/mediumImage/width
Opcionalnumeric
Píxeles totales entre el límite izquierdo y el límite derecho de la imagen.
data/params/smallImage
Opcionalstruct
Bloque de parámetros opcionales para la imagen pequeña.
data/params/smallImage/flipHorizontally
Opcionalfalseboolean
Invierte la imagen horizontalmente (eje X).
data/params/smallImage/flipVertically
Opcionalfalseboolean
Invierte la imagen verticalmente (eje Y).
data/params/smallImage/forceSize
Opcionalfalseboolean
Obliga a que las imágenes resultantes tengan las dimensiones exactas a las definidas en width y height. Este parámetro solo tiene efecto si resize=true.
data/params/smallImage/height
Opcionalnumeric
Píxeles totales entre el límite superior y el límite inferior de la imagen.
data/params/smallImage/pattern
Opcionalstring
Transforma el nombre de los archivos de imagen, una vez subidos, siguiendo un modelo de nomenclatura.
Ejemplos: Para el patrón '*_s' se le añadirá el sufijo '_s' a cualquier imagen.
data/params/smallImage/quality
Opcionalnumeric
Grado de degradación de la calidad de archivos '.jpg' en intervalos de 0.1 que equivalen a un 10% de degradación.
data/params/smallImage/resize
Opcionaltrueboolean
Cambia el ancho y el alto de la imagen para ajustarla a la width y/o height definida, conservando la proporcionalidad en el tamaño.
data/params/smallImage/width
Opcionalnumeric
Píxeles totales entre el límite izquierdo y el límite derecho de la imagen.
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"largeImage": {
"destination" :"",
"image": {
"clientFileExt" :"jpg",
"clientFileName" :"LALALAALads.jpg",
"fileName" :"LALALAALads-2.jpg",
"success" : true
}
},
"mediumImage": {
"destination" :"",
"image": {
"clientFileExt" :"jpg",
"clientFileName" :"LALALAALads.jpg",
"fileName" :"LALALAALads-2.jpg",
"success" : true
}
},
"smallImage": {
"destination" :"",
"image": {
"clientFileExt" :"jpg",
"clientFileName" :"LALALAALads.jpg",
"fileName" :"LALALAALads-2.jpg",
"success" : true
}
}
}