Referencia de métodos de servicio web
Utilización de API
Todos los métodos han de ser llamados a través de la puerta de enlace / API /. Por ejemplo, http://www.maboutique.com/api/carriers
La mayoría de los métodos se pueden acceder de una manera REST, con los 5 principales métodos de petición HTTP: HEAD, GET, POST, PUT, DELETE.
Las únicas excepciones son las siguientes:
search
: sólo pueden ser accedidos utilizando GET y HEAD.stock_movements
: no puede ser accedidos con PUT.
Todos los métodos cuentan con dos tipos opcionales, los cuales son añadidos al final de la URL:
?blank
: devuelve un árbol XML vacío del objeto elegido.?synopsis
: devuelve un árbol XML vacío del objeto elegido, con el formato esperado para cada valor (véase más adelante) y los indicadores específicos (ej., si el nodo es necesario y el tamaño máximo en número de caracteres).
Los métodos
Método | Descripción |
---|---|
addresses | El Cliente,Las direcciones del Fabricante y del Cliente |
carriers | Los transportistas |
carts | Carritos de los clientes |
categories | Las categorías de productos |
combinations | Las combinaciones de productos |
configurations | Configuración de la tienda |
content_management_system | Sistema de gestión del contenido |
countries | Los países |
currencies | Las monedas |
customers | Clientes de la tienda virtual |
deliveries | Entrega de producto |
employees | Los Empleados |
groups | Los grupos de clientes |
guests | Los invitados |
image_types | Los tipos de imagen |
images | Las imágenes |
images/general/header | El logo del encabezado de la tienda |
images/general/mail | El logo de los e-mails de la tienda |
images/general/invoice | El logo de la factura de la tienda |
images/general/store_icon | El logo de la tienda como un favicon |
images/products | Las imágenes de productos |
images/categories | Las imágenes de categorías |
images/manufacturers | Las imágenes de los fabricantes |
images/suppliers | Las imágenes de los proveedores |
images/stores | Las imágenes de las tiendas. |
languages | Idiomas de la tienda |
manufacturers | Los fabricantes de productos |
order_details | Detalles de un pedido |
order_discounts | Descuentos de un pedido |
order_histories | Los historiales de pedidos |
order_states | Los estados de pedidos |
orders | Pedidos de los Clientes |
price_ranges | Rangos de precio |
product_feature_values | Los valores de las características de los productos |
product_features | Las características de los productos |
product_option_values | Los valores de las opciones de los productos |
product_options | Las opciones de los productos |
products | Los productos |
search | Búsqueda |
states | Las provincias disponibles de países |
stock_movement_reasons | La razón del movimiento en el stock |
stock_movements | Gestión del movimiento en el stock |
stores | Las tiendas |
suppliers | Los proveedores de productos |
tags | Las etiquetas de Productos |
taxes | La tasas de impuesto |
translated_configurations | Configuración de la tienda |
weight_ranges | Rangos de peso |
zones | Las zonas de los Países |
Formatos de valor
Tipos de valor genérico
Formato | Descripción | Valor esperado, en formato regexp | ||
---|---|---|---|---|
isBool | Un valor booleano (verdadero o falso). | n/a | ||
isFloat | Un valor de punto flotante (entre -3.4 × 10^38 y +3.4 × 10^38). | n/a | ||
isInt | Un valor entero (entre -2,147,483,648 y 2,147,483,647). | n/a | ||
isNullOrUnsignedId | Un valor entero y sin signo (entre 0 y 4294967296), o un valor NULL. | n/a | ||
isSerializedArray | Datos serializados PHP |
| ||
isString | Una cadena de caracteres. | n/a | ||
isUnsignedId | Un valor entero y sin signo (entre 0 y 4294967296). | n/a |
Tipos de valor específico
Formato | Descripción | Valor esperado en formato regexp | ||
---|---|---|---|---|
isBirthDate | Una fecha válida, en formato AAAA-MM-DD. |
| ||
isCleanHtml | No debe contener etiquetas HTML ni XSS no válidos. | |||
isColor | Un color HTML / CSS válido, en formato #xxxxxx o formato de texto. |
| ||
isEmail | Una dirección de correo electrónico válida. |
| ||
isImageSize | Un tamaño de imagen válido, entre 0 y 9999. |
| ||
isLanguageCode | Un código de idioma válido, en formato XX o XX-XX. |
| ||
isLanguageIsoCode | Un código ISO de idioma válido, en formato XX o XXX. |
| ||
isLinkRewrite | Una reescritura de enlace válido. |
| ||
isMd5 | Una cadena MDR5 válida: 32 caracteres,mezclando minúsculas, mayúsculas y numerales. |
| ||
isNumericIsoCode | Un código ISO válido, en formato de 00 o 000. |
| ||
isPasswd | Una contraseña válida, entre 5 y 32 caracteres. |
| ||
isPasswdAdmin | Una contraseña válida, entre 8 y 32 caracteres.. |
| ||
isPhpDateFormat | Una fecha de PHP válida - de hecho, una cadena sin '<', ni '>'. |
| ||
isPriceDisplayMethod | Un método de precio mostrado válido, es decir, el valor será igual a las constantes PS_TAX_EXC o PS_TAX_INC | n/a | ||
isReference | Una referencia de producto válida. |
| ||
isUrl | Una URL válida. |
|
Nombres
Formato | Descripción | Valor esperado en formato regexp | ||
---|---|---|---|---|
isCatalogName | Un producto o nombre de categoría válido. |
| ||
isCarrierName | Un nombre de transportista válido. |
| ||
isConfigName | Una clave de configuración válida. |
| ||
isGenericName | Un nombre estándar válido. |
| ||
isImageTypeName | Un tipo de imagen válido. |
| ||
isName | Un nombre válido. |
| ||
isTplName | Un nombre de la plantilla válido. |
|
Ubicación
Formato | Descripción | Valor esperado en formato regexp | ||
---|---|---|---|---|
isAddress | Una dirección postal válida. |
| ||
isCityName | Un nombre de ciudad válido. |
| ||
isCoordinate | Una coordenada LatLong válida, en formato 00000.0000. |
| ||
isMessage | Un mensaje válido. |
| ||
isPhoneNumber | Un número de teléfono válido. |
| ||
isPostCode | Un código postal válido. |
| ||
isStateIsoCode | Un código ISO de estado o provincia válido. |
| ||
isZipCodeFormat | Un formato de código postal válido. |
|
Products
Formato | Descripción | Valor esperado en formato regexp | ||
---|---|---|---|---|
isAbsoluteUrl | Una URL absoluta válida. |
| ||
isDniLite | Un DNI (Documento Nacional de Identidad). Específico a las tiendas españolas. |
| ||
isEan13 | Un código de barras válido (EAN13). |
| ||
isLinkRewrite | Una URL amigable válida. |
| ||
isPrice | Un método de muestra de precio válido (ya sea PS_TAX_EXC o PS_TAX_INC). | n/a | ||
isUpc | Un código de barras válido (UPC). |
|