DocumentationCommerce« Guide Catalog Service »

Intégration et installation

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Administration

Installez le service de catalogue pour demander et recevoir des données de produit d’une instance Commerce à l’aide de l’ API GraphQL de service de catalogue. Le service de catalogue est fourni en tant que métapaquet de compositeur à partir du référentiel repo.magento.com.

NOTE
Si votre instance Commerce utilise Live Search ou Product Recommendations, le service de catalogue est installé ou mis à jour automatiquement lorsque vous embarquez ou mettez à niveau ces services. Pour plus d’informations, reportez-vous aux instructions d’installation pour Live Search et Product Recommendations.

Configuration requise

Exigences logicielles

  • Adobe Commerce 2.4.4+
  • PHP 8.1, 8.2, 8.3
  • Compositeur : 2.x

Plateformes prises en charge

  • Adobe Commerce sur l’infrastructure cloud : 2.4.4+
  • Adobe Commerce sur site : 2.4.4+

Points de fin

Catalog Service comporte deux points de terminaison disponibles pour l’intégration :

  • Environnement de test (https://catalog-service-sandbox.adobe.io/graphql) : utilisé pour le test et la validation avant la mise en ligne.
  • Production (https://catalog-service.adobe.io/graphql) : utilisé pour le trafic en direct des marchands et des sites web Commerce

Toutes les instances de test Commerce utilisent le point de terminaison Sandbox.

Exécutez tous les tests de chargement sur le point de terminaison Sandbox. Avant de commencer le test de chargement, envoyez un ticket d’assistance afin que l’équipe des services puisse anticiper le trafic de serveur supplémentaire.

Installation et configuration

Pour commencer à utiliser Catalog Service pour Adobe Commerce, les étapes suivantes sont requises :

  • Installation de l’extension Catalog Service (magento/catalog-service)
  • Configuration du service et de l’exportation des données
  • Accès au service

Installation de l’extension Catalog Service

recommendation-more-help

Condition préalable requise

style
shade-box

Installez la dernière version de l’extension Catalog Services (magento/catalog-service) sur une instance Adobe Commerce qui exécute Adobe Commerce version 2.4.4 ou ultérieure. Le service de catalogue est fourni en tant que métapaquet de compositeur à partir du référentiel repo.magento.com.

Infrastructure cloud

Utilisez cette méthode pour installer Catalog Service pour une instance de Commerce Cloud.

  1. Sur votre poste de travail local, modifiez le répertoire du projet pour votre projet Adobe Commerce sur l’infrastructure cloud.

    note note
    NOTE
    Pour plus d’informations sur la gestion locale des environnements de projet Commerce, voir Gestion des branches avec l’interface de ligne de commande dans le Guide de l’utilisateur d’Adobe Commerce on Cloud Infrastructure.

  2. Consultez la branche d’environnement pour mettre à jour à l’aide de l’interface de ligne de commande de Adobe Commerce Cloud.

    code language-shell 
    magento-cloud environment:checkout <environment-id>

  3. Ajoutez le module Catalog Service.

    code language-bash 
    composer require magento/catalog-service --no-update

  4. Mettez à jour les dépendances de package.

    code language-bash 
    composer update "magento/catalog-service"

  5. Validez et poussez les modifications de code pour les fichiers composer.json et composer.lock.

  6. Ajoutez, validez et poussez les modifications de code des fichiers composer.json et composer.lock dans l’environnement cloud.

    code language-shell 
    git add -A
git commit -m "Add catalog service module"
git push origin <branch-name>

    La publication des mises à jour dans l’environnement cloud lance le processus de déploiement cloud de Commerce pour appliquer les modifications. Vérifiez l’état du déploiement à partir du log de déploiement.

Sur site

Utilisez cette méthode pour installer Catalog Service pour une instance sur site.

  1. Utilisez le compositeur pour ajouter le module de service de catalogue à votre projet :

    code language-bash 
    composer require magento/catalog-service --no-update

  2. Mettez à jour les dépendances et installez l’extension :

    code language-bash 
    composer update  "magento/catalog-service"

  3. Mettre à niveau Adobe Commerce :

    code language-bash 
    bin/magento setup:upgrade

  4. Effacez le cache :

    code language-bash 
    bin/magento cache:clean
    note tip
    TIP
    Dans certains cas, en particulier lors du déploiement en production, vous souhaiterez peut-être éviter de supprimer le code compilé, car cela peut prendre du temps. Assurez-vous de sauvegarder votre système avant d’apporter des modifications.

Configuration du service et de l’exportation des données

Après avoir installé Catalog Service, effectuez les tâches suivantes pour intégrer le service de catalogue à votre instance Adobe Commerce. Cette intégration permet la synchronisation et la communication des données entre l’instance Commerce, le service de catalogue et d’autres services annexes.

  1. Configurez le Connecteur de services Commerce en spécifiant les clés d’API et en sélectionnant un espace de données SaaS.

    La configuration de Commerce Services Connector est un processus unique requis pour utiliser les services Adobe Commerce tels que le service de catalogue, la recherche en direct et le Recommendations de produit. Si vous avez déjà configuré le connecteur pour un autre service, ignorez cette étape.

  2. Effectuez une synchronisation initiale des données à partir du tableau de bord de Data Management.

    La synchronisation initiale peut prendre de quelques minutes à des heures selon la taille du catalogue. Vous pouvez surveiller l’état de synchronisation à partir du tableau de bord Data Management. Après la synchronisation initiale, le catalogue exporte en permanence les données de produit afin de maintenir les services à jour.

    note note
    NOTE
    Vous pouvez également démarrer la synchronisation initiale à partir de la ligne de commande à l’aide de l’interface de ligne de commande de Commerce. Voir Synchronisation initiale dans le Guide d’exportation des données SaaS.

Pour vous assurer que l’exportation du catalogue s’exécute correctement :

  • Vérifiez que les tâches cron sont en cours d’exécution.
  • Vérifiez que les indexeurs s’exécutent à partir de Admin ou à l’aide de la commande d’interface de ligne de commande Commerce bin/magento indexer:info.
  • Vérifiez que les indexeurs Catalog Attributes Feed, Product Feed, Product Overrides Feed et Product Variant Feed sont définis sur Update by Schedule.

Accès au service

L’API GraphQL Catalog Service est accessible à partir du point d’entrée https://catalog-service.adobe.io/graphql à l’aide de commandes de POST via HTTPS.

Dans vos requêtes GraphQL, vous devez spécifier plusieurs en-têtes HTTP, y compris la clé API publique que vous avez ajoutée à la configuration du connecteur Adobe Commerce Services dans l’Admin. Pour plus d’informations, consultez la documentation de Storefront Services GraphQL .

Configuration du pare-feu

Pour autoriser Catalog Service par le biais d’un pare-feu, ajoutez commerce.adobe.io à la liste autorisée.

Service de catalogue et maillage d’API

Le Mesh API pour Adobe Developer App Builder permet aux développeurs d’intégrer des API privées ou tierces et d’autres interfaces avec des produits Adobe à l’aide d’Adobe IO.

Pour plus d’informations sur l’installation et la configuration, voir la rubrique Catalog Service et maillage API .

Tableau de bord de la gestion des données

Pour plus d’informations sur la synchronisation des données Catalog Service, consultez le tableau de bord de Data Management.

7c786b3e-f793-4e26-b38a-3fe76d8eca72