Shopware ofrece dos interfaces REST, la Store API y la Admin API, pero ninguna API GraphQL oficial. Mostramos la autenticación y peticiones de ejemplo para ambas y explicamos qué aportan proyectos GraphQL como SwagGraphQL a las tiendas online en España.
REST (Representational State Transfer) es un estilo de arquitectura para aplicaciones en red. Las API REST se consultan mediante HTTP y las operaciones habituales se realizan con los métodos GET (leer), POST (crear), PATCH o PUT (modificar) y DELETE (eliminar). Shopware 6 ofrece dos interfaces REST, que son también la base para conectar una tienda online en España con sus sistemas externos:
Ambas interfaces intercambian datos en formato JSON y devuelven el resultado mediante códigos de estado HTTP, por ejemplo 200 para éxito o 401 por falta de autorización. Los apartados siguientes muestran la autenticación y peticiones de ejemplo. Encontrará los fundamentos de la plataforma en nuestra página sobre desarrollo con Shopware.
La Store API es el acceso a la Storefront de Shopware. Así se autoriza y envía las primeras peticiones.
La Store API exige una sw-access-key vinculada a un canal de venta:
https://su-tienda.es/admin.Shopware incluye una interfaz Swagger para probar la Store API:
https://su-tienda.es/store-api/_info/swagger.html.sw-access-key y confirme.A continuación podrá probar todos los endpoints directamente en el navegador.
Una petición POST a /store-api/product devuelve una lista de productos. La Store API acepta en el cuerpo criterios de búsqueda como límite, filtros y ordenación. Con cURL:
curl -X POST https://su-tienda.es/store-api/product \
-H "sw-access-key: SU_ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"limit": 10}'
La respuesta es un JSON con un array elements que contiene productos con nombre, precio e ID:
{
"elements": [
{
"id": "0190d2e8f2b47c6f9d1a0c5e8b3f1a2b",
"name": "Producto de ejemplo",
"calculatedPrice": { "totalPrice": 19.99 },
"stock": 100
}
],
"total": 1
}
Si su tienda tiene varios idiomas, por ejemplo un canal de venta para España con contenidos en español, puede solicitar los textos en el idioma deseado enviando la cabecera sw-language-id con el ID del idioma correspondiente.
Las tiendas headless funcionan íntegramente a través de estas interfaces. Por eso, elegir entre REST y GraphQL es una decisión de arquitectura: REST es una tecnología madura y está soportada por las herramientas oficiales de Shopware; GraphQL ofrece una carga de datos más flexible para frontends complejos, pero en Shopware no tiene estatus oficial (más detalles a continuación).
La Admin API está pensada para integraciones de backend y da acceso a los datos maestros de Shopware. Utiliza OAuth 2.0.
Con las credenciales de la integración, solicite un token mediante POST /api/oauth/token:
curl -X POST https://su-tienda.es/api/oauth/token \
-H "Content-Type: application/json" \
-d '{
"grant_type": "client_credentials",
"client_id": "SU_ID_DE_CLAVE_DE_ACCESO",
"client_secret": "SU_CLAVE_DE_SEGURIDAD"
}'
La respuesta contiene un token válido durante diez minutos:
{
"token_type": "Bearer",
"expires_in": 600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."
}
Con el token, llame a la Admin API. GET /api/product devuelve una lista de productos:
curl -X GET https://su-tienda.es/api/product \
-H "Authorization: Bearer SU_ACCESS_TOKEN" \
-H "Content-Type: application/json"
El stock se modifica con una petición PATCH a /api/product/{id-producto}:
curl -X PATCH https://su-tienda.es/api/product/0190d2e8f2b47c6f9d1a0c5e8b3f1a2b \
-H "Authorization: Bearer SU_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "stock": 150 }'
Para cambios masivos, la Admin API ofrece el endpoint de sincronización POST /api/_action/sync, que escribe muchos registros en una sola llamada. Y si prefiere que se le informe de los cambios en lugar de consultarlos, lea nuestro artículo sobre webhooks en Shopware 6.
GraphQL es un lenguaje de consulta en el que el cliente indica exactamente qué datos necesita. Esto evita el over-fetching y puede ser más eficiente que REST. En lugar de muchos endpoints hay uno solo, normalmente /graphql. Sin embargo, Shopware no ofrece una API GraphQL oficial. GraphQL solo puede añadirse mediante proyectos de la comunidad como SwagGraphQL.
SwagGraphQL es una prueba de concepto de shopwareLabs que coloca una API GraphQL sobre la API central de Shopware. Se basa en la biblioteca webonyx/graphql-php y se integra como plugin en Shopware 6. El proyecto ya no se mantiene, se creó para versiones tempranas de Shopware 6 y no debería usarse en producción sin adaptaciones importantes.
Para probarlo en un entorno de desarrollo:
# Clonar el repositorio en la carpeta de plugins
git clone https://github.com/shopwareLabs/SwagGraphQL.git custom/plugins/SwagGraphQL
# Instalar las dependencias del plugin
cd custom/plugins/SwagGraphQL && composer install && cd -
# Registrar y activar el plugin
bin/console plugin:refresh
bin/console plugin:install --activate SwagGraphQL
bin/console cache:clear
Tras la instalación, el endpoint está disponible en https://su-tienda.es/graphql/query y puede consultarse con herramientas como GraphiQL. Una consulta de productos tiene este aspecto:
query {
products {
id
name
price
}
}
Quien necesita GraphQL en el frontend construye en la práctica una capa propia: un BFF (Backend for Frontend) en Node.js o PHP que ofrece GraphQL hacia fuera y llama internamente a la Store API y a la Admin API. Las plataformas de middleware como Alumio conectan Shopware con sistemas basados en GraphQL, pero no sustituyen una API GraphQL nativa en el núcleo de Shopware. Para automatizaciones sencillas entre sistemas, a menudo basta con n8n.
sw-access-key, es incorrecta o pertenece a otro canal de venta./store-api/product.includes y associations), pagine los resultados y almacene las respuestas en caché.Con la Store API y la Admin API, Shopware cubre por completo mediante REST la conexión de frontends propios y sistemas externos. No existe una API GraphQL oficial; los proyectos de la comunidad como SwagGraphQL solo sirven para experimentar. Quien necesita GraphQL en el frontend coloca una capa propia delante de las interfaces REST. Bien configuradas y gestionadas según las reglas descritas, las API de Shopware son la base de frontends headless, sincronizaciones con el CRM y automatizaciones. Si para su tienda en España necesita un plugin o una app, le ayudamos con el desarrollo de plugins para Shopware; nuestro análisis de tienda le ofrece una primera visión general.