Shopware propose deux interfaces REST, la Store API et l’Admin API, mais pas d’API GraphQL officielle. Nous présentons l’authentification et des exemples de requêtes pour les deux et faisons le point sur des projets GraphQL comme SwagGraphQL, pour les boutiques en ligne en France.
REST (Representational State Transfer) est un style d’architecture pour les applications en réseau. Les API REST s’appellent via HTTP, et les opérations courantes passent par les méthodes GET (lire), POST (créer), PATCH ou PUT (modifier) et DELETE (supprimer). Pour les boutiques en ligne françaises qui connectent Shopware 6 à d’autres systèmes, la plateforme met à disposition deux interfaces REST :
Les deux interfaces échangent des données au format JSON et renvoient le résultat via des codes de statut HTTP, par exemple 200 en cas de succès ou 401 en cas d’autorisation manquante. Les sections suivantes présentent l’authentification et des exemples de requêtes. Les bases de la plateforme sont présentées sur notre page consacrée au développement Shopware.
La Store API est la porte d’entrée vers la storefront de Shopware. Voici comment vous authentifier et envoyer vos premières requêtes.
La Store API exige une sw-access-key liée à un canal de vente :
https://votre-boutique.fr/admin.Shopware fournit une interface Swagger pour tester la Store API :
https://votre-boutique.fr/store-api/_info/swagger.html.sw-access-key et validez.Vous pouvez ensuite tester tous les endpoints directement dans le navigateur.
Une requête POST vers /store-api/product renvoie une liste de produits. La Store API accepte dans le corps des critères de recherche comme la limite, les filtres et le tri. Avec cURL :
curl -X POST https://votre-boutique.fr/store-api/product \
-H "sw-access-key: VOTRE_ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{"limit": 10}'
La réponse est un JSON contenant un tableau elements avec les produits, leurs noms, prix et identifiants :
{
"elements": [
{
"id": "0190d2e8f2b47c6f9d1a0c5e8b3f1a2b",
"name": "Produit exemple",
"calculatedPrice": { "totalPrice": 19.99 },
"stock": 100
}
],
"total": 1
}
Les boutiques headless fonctionnent entièrement via ces interfaces. Le choix entre REST et GraphQL est donc une décision d’architecture : REST est mature et pris en charge par les outils officiels de Shopware, GraphQL permet un chargement de données plus flexible pour des frontends complexes, mais n’a pas de statut officiel dans Shopware (voir plus bas).
L’Admin API est destinée aux intégrations back-office et donne accès aux données de référence de Shopware. Elle utilise OAuth 2.0.
Avec les identifiants de l’intégration, vous demandez un token via POST /api/oauth/token :
curl -X POST https://votre-boutique.fr/api/oauth/token \
-H "Content-Type: application/json" \
-d '{
"grant_type": "client_credentials",
"client_id": "VOTRE_ID_CLE_ACCES",
"client_secret": "VOTRE_CLE_SECRETE"
}'
La réponse contient un token valable dix minutes :
{
"token_type": "Bearer",
"expires_in": 600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."
}
Avec ce token, vous appelez l’Admin API. GET /api/product renvoie une liste de produits :
curl -X GET https://votre-boutique.fr/api/product \
-H "Authorization: Bearer VOTRE_ACCESS_TOKEN" \
-H "Content-Type: application/json"
Vous modifiez le stock avec une requête PATCH vers /api/product/{id-produit} :
curl -X PATCH https://votre-boutique.fr/api/product/0190d2e8f2b47c6f9d1a0c5e8b3f1a2b \
-H "Authorization: Bearer VOTRE_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "stock": 150 }'
Pour les modifications en masse, l’Admin API propose l’endpoint de synchronisation POST /api/_action/sync, qui écrit de nombreux enregistrements en un seul appel. Et si vous préférez être informé des modifications plutôt que de les interroger, lisez notre article sur les webhooks dans Shopware 6.
GraphQL est un langage de requête dans lequel le client indique précisément les données dont il a besoin. Cela évite l’over-fetching et peut être plus efficace que REST. Au lieu de nombreux endpoints, il n’en existe qu’un seul, généralement /graphql. Shopware ne propose cependant pas d’API GraphQL officielle. GraphQL ne peut être ajouté que via des projets communautaires comme SwagGraphQL.
SwagGraphQL est un proof of concept de shopwareLabs qui superpose une API GraphQL à l’API centrale de Shopware. Il repose sur la bibliothèque webonyx/graphql-php et s’intègre comme plugin dans Shopware 6. Le projet n’est plus maintenu, a été conçu pour les premières versions de Shopware 6 et ne devrait pas être utilisé en production sans adaptations importantes.
Pour l’essayer dans un environnement de développement :
# Cloner le dépôt dans le dossier des plugins
git clone https://github.com/shopwareLabs/SwagGraphQL.git custom/plugins/SwagGraphQL
# Installer les dépendances du plugin
cd custom/plugins/SwagGraphQL && composer install && cd -
# Enregistrer et activer le plugin
bin/console plugin:refresh
bin/console plugin:install --activate SwagGraphQL
bin/console cache:clear
Après l’installation, l’endpoint est accessible sous https://votre-boutique.fr/graphql/query et peut être interrogé avec des outils comme GraphiQL. Une requête sur les produits se présente ainsi :
query {
products {
id
name
price
}
}
Dans la pratique, les équipes qui ont besoin de GraphQL dans le frontend construisent leur propre couche : un BFF (Backend for Frontend) en Node.js ou en PHP, qui expose GraphQL vers l’extérieur et appelle en interne la Store API et l’Admin API. Des plateformes middleware comme Alumio relient Shopware à des systèmes basés sur GraphQL, mais ne remplacent pas une API GraphQL native dans le cœur de Shopware. Pour des automatisations simples entre systèmes, n8n suffit souvent.
sw-access-key est absente, erronée ou appartient à un autre canal de vente./store-api/product.includes et associations), paginer les résultats, mettre les réponses en cache.Avec la Store API et l’Admin API, Shopware couvre entièrement en REST la connexion de frontends sur mesure et de systèmes externes. Il n’existe pas d’API GraphQL officielle, et des projets communautaires comme SwagGraphQL ne conviennent qu’à des expérimentations. Si vous avez besoin de GraphQL dans le frontend, placez votre propre couche devant les interfaces REST. Bien configurées et exploitées selon les règles ci-dessus, les API Shopware constituent la base de frontends headless, de synchronisations CRM et d’automatisations pour les boutiques en ligne en France. Si vous avez besoin d’un plugin ou d’une app pour cela, nous vous accompagnons avec notre offre de développement de plugins Shopware ; notre analyse de boutique vous donne une première vue d’ensemble de votre boutique.