Cas d'usage pour BSS B2B Solution

Synchroniser les règles B2B et les clients avec votre ERP via API

Utilisez la Public API de BSS B2B Solution pour créer et mettre à jour les règles Custom Pricing, Price List, Volume Pricing et les données d'inscription depuis votre ERP ou PIM, avec une clé API, au lieu de modifier les règles à la main.

  • Application: BSS B2B Solution
  • Modèle économique: Distributeur
  • Fonctionnalité clé: Public API

Dernière mise à jour

Relu par Hoa Nguyen. Dernière relecture

Carte de clé API dans BSS B2B Solution juste après la génération d'une clé, avec la clé masquée et les boutons Copy et Download
  • 4,9/5 1 190 avis sur BSS B2B Solution sur le Shopify App Store
  • Built for Shopify Badge que Shopify attribue aux applications respectant ses normes de qualité
  • 20 langues prises en charge dans l'application

Le problème

Les prix, les clients et les règles vivent déjà dans un ERP, un PIM ou un tableur, et personne ne veut les maintenir une seconde fois dans l'application. Copier les changements à la main est lent, et les deux systèmes finissent par diverger. Les grands catalogues aggravent le problème chaque mois.

Le résultat

Votre développeur ou votre intégrateur envoie les règles de prix depuis le système de référence vers BSS B2B Solution avec une clé API. Les règles activées sont envoyées au thème en ligne, et la carte Logs and usage affiche chaque requête et la raison d'un échec.

fonctionnement

Comment ça marche

  1. Vérifier le forfait

    La Public API fait partie du forfait Platinum. Confirmez le forfait avant de prévoir tout travail d'intégration.

  2. Générer la clé API

    Ouvrez Integrations dans l'application, repérez la carte Public API, cliquez sur Get API key et générez la clé. Copiez-la ou téléchargez-la tout de suite, car elle n'est affichée qu'une seule fois.

  3. Envoyer une première requête

    Appelez un point d'accès version 1 avec le domaine de votre boutique et la clé, soit comme champ accessKey dans le corps, soit dans l'en-tête x-bss-b2b-api-key.

  4. Écrire les règles à partir des données ERP

    Créez, mettez à jour ou supprimez les enregistrements Custom Pricing, Price List, Volume Pricing, code de remise et inscription avec le groupe de points d'accès correspondant, en lot lorsque le point d'accès le permet.

  5. Envoyer les règles activées

    Appelez le point d'accès d'upload du module pour que les règles activées atteignent votre thème actif, au maximum une fois par module toutes les 5 minutes.

  6. Surveiller les journaux

    Ouvrez Logs and usage pour voir chaque requête, son statut, et la requête et la réponse complètes en cas d'échec.

Pour synchroniser les prix B2B depuis un ERP vers Shopify, utilisez la Public API de BSS B2B Solution : générez une clé API sur le forfait Platinum, puis demandez à votre développeur ou à votre intégrateur de créer, mettre à jour et supprimer les règles Custom Pricing, Price List et Volume Pricing depuis votre système de référence, et d'appeler le point d'accès d'upload pour que les règles activées atteignent le thème en ligne. Votre équipe arrête de ressaisir les prix dans un écran d'administration.

Ce guide s'adresse aux distributeurs et aux fabricants dont les prix, les classes de prix ou les groupes de clients sont déjà gérés dans un ERP, un PIM ou un flux de données. Il explique qui en profite, ce que l'API couvre et ne couvre pas, un plan d'intégration en cinq étapes, un exemple détaillé et les limites à prendre en compte, notamment l'absence de point d'accès pour les commandes. Il s'adresse à la personne qui décide de créer l'intégration, et renvoie à la documentation développeur pour les formats exacts.

À qui s'adresse cette solution

La Public API vous convient si la plupart de ces points décrivent votre boutique :

  • Vos prix sont gérés dans un ERP, un PIM ou un tableur maître, et la boutique Shopify n'est qu'une deuxième copie.
  • Vous avez plusieurs classes de prix ou groupes de clients, et une modification de prix touche des centaines ou des milliers de variantes.
  • Les prix changent chaque semaine ou chaque jour, si bien qu'une mise à jour manuelle prend du retard entre deux synchronisations.
  • Vous avez un développeur, une agence ou un intégrateur capable d'écrire une tâche planifiée.
  • Vous exportez déjà vos prix en CSV et voulez que ces données circulent sans que personne ouvre l'application.

Si votre liste de prix ne change que quelques fois par an, un import CSV est plus simple. Voir importer des prix de gros depuis un CSV.

Pourquoi c'est important

Deux copies d'une liste de prix finissent par diverger. Quelqu'un met à jour l'ERP le lundi, oublie la boutique, et un acheteur voit mardi le prix du trimestre précédent. Il commande alors au mauvais prix, et vous absorbez l'écart ou annulez la commande, ou il perd confiance dans le portail et appelle le service commercial. Plus le catalogue est grand et plus vous avez de classes de prix, plus cela arrive souvent.

Un flux de données traite la cause plutôt que le symptôme. L'ERP reste le système de référence, une tâche planifiée écrit les modifications dans BSS B2B Solution, et la vitrine suit. Les boutiques réelles veulent cette souplesse. Alpha Coffee, torréfacteur, indique qu'avec un accès API il peut garder Shopify comme couche commerciale centrale tout en se connectant à des plateformes ERP, CRM ou finance, et DermaplanePro signale moins de travail manuel grâce aux connexions API publiques avec des systèmes externes. Voir les études de cas Alpha Coffee et DermaplanePro.

Comment la mettre en place avec BSS B2B Solution

Cette section décrit l'intégration côté marchand. Votre développeur a besoin du guide de la Public API pour les points d'accès et les formats.

Étape 1 : vérifier le forfait

La Public API fait partie du forfait Platinum. Une boutique ne peut détenir qu'une clé API à la fois, et ce forfait débloque aussi les Price Lists, que de nombreuses intégrations ERP utilisent pour les prix propres à chaque client. Vérifiez le forfait avant de cadrer tout travail d'intégration.

Étape 2 : générer la clé API

Dans l'application, ouvrez Integrations, repérez la carte Public API et choisissez Get API key. La clé n'est affichée qu'une fois : copiez-la ou téléchargez-la à ce moment-là et conservez-la dans un gestionnaire de mots de passe ou une variable d'environnement serveur. En cas de fuite, supprimez-la sur la même carte, ce qui arrête tous les clients qui l'utilisent, puis générez-en une nouvelle.

Page Integrations dans l'administration de BSS B2B Solution avec la carte Public API et son bouton Get API key
Ouvrez Integrations et repérez la carte Public API.
Carte de clé API indiquant que la clé est générée, masquée, avec les boutons Copy et Download
La clé est générée et affichée une seule fois : copiez-la ou téléchargez-la immédiatement.

Étape 3 : authentifier votre première requête

Les points d'accès de la version 1 reçoivent votre domaine `myshopify.com` et la clé, soit comme `accessKey` dans le corps de la requête, soit dans l'en-tête `x-bss-b2b-api-key`. Le point d'accès de volume pricing de la version 2 utilise l'en-tête `x-api-key`. Un jeton Bearer n'est pas pris en charge et renvoie une erreur 401, donc ne construisez pas votre client autour de l'en-tête `Authorization`.

Étape 4 : écrire les règles à partir de vos données ERP

Associez chaque classe de prix de l'ERP à une cible de règle, comme un tag de client, et appelez le groupe de points d'accès du module que vous utilisez. L'API gère les règles Custom Pricing, Price List et Volume Pricing, les règles de codes de remise, les enregistrements de formulaire d'inscription et les règles de limite de commande, avec création, mise à jour, suppression et opérations en lot là où le point d'accès le permet. Les points d'accès clients et produits sont des consultations en lecture seule qui vous aident à construire les charges utiles des règles, par exemple pour retrouver des clients par tag ou lister des produits et des collections. Les requêtes sont traitées une à la fois, donc votre client doit mettre ses appels en file d'attente.

Page Custom Pricing dans l'administration de BSS B2B Solution, avec une liste de règles, leurs clients, remises, priorités et statuts
Les règles écrites par votre intégration apparaissent dans les mêmes listes de règles que votre équipe utilise dans l'administration.

Étape 5 : envoyer une fois, puis vérifier

Après un lot de modifications, appelez le point d'accès d'upload du module pour que toutes les règles activées soient écrites dans votre thème actif. Les points d'accès d'upload autorisent une requête par module toutes les cinq minutes. Envoyez donc une fois à la fin d'une synchronisation, et non après chaque ligne. Une requête au-delà de la limite renvoie `429`, et seules les règles activées sont envoyées. Si vos règles dépassent la capacité des métachamps, l'API enregistre ce qui tient et renvoie un rapport `partial_success` avec un code HTTP 200, donc lisez le corps de la réponse et pas seulement le code d'état. Vérifiez ensuite le résultat dans la carte Logs and usage sous Advanced Settings > Public API, qui liste les requêtes récentes avec l'heure, la méthode, le chemin et le statut, et affiche la requête et la réponse complètes en cas d'échec. L'API peut aussi renvoyer le prix qu'un client donné obtient pour certains produits, ce qui est utile pour comparer l'application avec l'ERP.

Collection de la boutique de démonstration pour un client grossiste, où chaque produit affiche le prix public barré à côté du prix de gros
Après l'upload, la vitrine affiche les prix issus de vos données.

Exemple : un distributeur avec trois classes de prix

Cet exemple utilise des chiffres fictifs, pas des résultats d'une boutique réelle. Un distributeur gère trois classes de prix dans son ERP : Retail Partner, Trade et Key Account. Dans BSS B2B Solution, chaque classe est une règle Price List qui cible un tag de client. Une tâche nocturne exporte les lignes de prix modifiées, les regroupe par classe, et appelle le point d'accès d'enregistrement en lot pour chaque Price List. Quand les trois sont terminés, la tâche appelle une fois le point d'accès d'upload des Price Lists.

Un lundi, l'ERP affiche 3 200 prix modifiés. Au lieu qu'un analyste les ressaisisse, la tâche s'exécute à 02:00, envoie une fois, puis vérifie la carte Logs and usage pour détecter toute requête en échec. Le matin, un acheteur Trade qui se connecte voit les prix du lundi sur les pages produit et collection. Une requête en échec laisse une entrée dans le journal avec son statut et son corps, et la tâche la rejoue après une courte attente.

Page Price Lists dans l'administration de BSS B2B Solution, avec le module activé et une règle pour les clients connectés
Une page Price Lists avec une règle de liste pour un groupe de clients : le même type de règle que votre intégration écrit.

Se combine bien avec

L'API est une voie d'entrée pour le moteur de tarification. Les autres pages expliquent ce qui se passe avec ces règles une fois créées :

Le hub de tarification de gros regroupe les guides de tarification. Les entrées de glossaire utiles sont price list, prix de gros et tag client.

Page Import and export dans BSS B2B Solution, avec les cartes Export et Import et une section d'historique des exports
La page Import and export est l'alternative sans code pour les catalogues plus petits.

Limites et erreurs courantes

  • Il n'existe pas de point d'accès pour les commandes. L'API gère les règles de prix et de remise, les enregistrements d'inscription et les règles de limite de commande, ainsi que des consultations en lecture seule des clients, produits et collections. Gardez la synchronisation des commandes dans votre connecteur ERP pour Shopify, et utilisez cette API pour les prix et les groupes de clients.
  • Une clé par boutique. Supprimer la clé arrête tous les clients qui l'utilisent. Renouvelez-la donc depuis un forfait et mettez l'intégration à jour immédiatement.
  • L'upload est limité en débit. Les points d'accès d'upload autorisent une requête par module toutes les cinq minutes. Le point d'accès de volume pricing de la version 2 autorise 60 requêtes par période de 60 secondes pour chaque boutique.
  • Les données de tarification ont des plafonds. Les règles sont stockées dans des métachamps Shopify, avec au maximum 10 clés et 2 000 000 de caractères par clé. Le contenu au-delà des plafonds est ignoré et signalé comme `partial_success`. Élaguez donc les règles inactives ou divisez un jeu de règles très volumineux avant de renvoyer un upload.
  • Les nouvelles tentatives demandent une pause. Les requêtes sont traitées une à la fois, et après une erreur serveur, le guide indique d'attendre jusqu'à trois minutes avant de réessayer.
  • L'API ne remplace pas la conception des règles. Le ciblage, la priorité et les exclusions suivent les mêmes règles que les règles créées à la main. Testez donc d'abord une règle dans l'administration.
  • L'API alimente une vitrine de thème. Les prix s'affichent par l'app embed de BSS B2B Solution dans votre thème Shopify. Vérifiez donc que l'embed est activé après chaque changement de thème.

Liste de contrôle de la configuration

  • Vérifiez que la boutique est sur le forfait Platinum.
  • Décidez du système de référence pour chaque classe de prix et du tag client auquel chaque classe correspond.
  • Générez la clé API et conservez-la dans un gestionnaire de mots de passe ou une variable d'environnement.
  • Construisez le client avec `accessKey` ou l'en-tête `x-bss-b2b-api-key`, et mettez les requêtes en file d'attente.
  • Testez une règle de bout en bout sur une boutique de développement, puis vérifiez-la dans l'administration.
  • Prévoyez un appel d'upload par module à la fin de chaque synchronisation.
  • Ajoutez des alertes sur `429` et sur les erreurs serveur, et consultez la carte Logs and usage après les premières exécutions.
  • Gardez la synchronisation des commandes dans un connecteur séparé.

Forfaits et prérequis

La Public API nécessite le forfait Platinum de BSS B2B Solution, une clé par boutique et l'app embed sur votre thème. Les autres forfaits et l'essai gratuit de 14 jours sur les forfaits payants figurent sur la page tarifs de BSS B2B. Les formats exacts se trouvent dans le guide de la Public API, le guide de l'API d'upload et le guide de l'API Custom Pricing. Installez BSS B2B Solution depuis la boutique d'applications Shopify et demandez à votre développeur de commencer par une seule Price List.

fonctionnalités clés

Ce qui le rend possible

Points d'accès des règles

Lisez, créez, mettez à jour et supprimez les règles Custom Pricing, Price List et Volume Pricing depuis du code, y compris l'enregistrement en lot et la suppression de masse.

Consultations clients et produits

Points d'accès en lecture seule pour retrouver les clients par tag, identifiant ou recherche, et lister les produits et collections pour vos charges utiles de règles.

Upload vers le thème

Une requête envoie toutes les règles activées vers le thème actif pour que la vitrine reflète vos données.

Journaux et usage

Une carte de l'application liste les requêtes récentes avec l'heure, la méthode, le chemin et le statut.

Mettez cela en place avec BSS B2B Solution

Installez BSS B2B Solution depuis le Shopify App Store, puis suivez le guide pour l'activer sur votre boutique.

faq

Questions fréquentes

Quel forfait inclut la Public API ?

Le forfait Platinum. Une boutique ne peut détenir qu'une clé API à la fois. Si une clé fuit, supprimez-la sur la carte Public API dans Integrations : tous les clients qui l'utilisent s'arrêtent immédiatement. Vous pouvez ensuite générer une nouvelle clé et mettre votre intégration à jour. Traitez la clé comme un mot de passe et conservez-la dans une variable d'environnement serveur.

Puis-je synchroniser les commandes via l'API ?

Non. L'API gère les règles de prix et de remise, les enregistrements du formulaire d'inscription et les règles de limite de commande, ainsi que des consultations en lecture seule des clients, produits et collections. Elle n'a pas de ressource pour les commandes. Les commandes restent dans Shopify : utilisez les outils Shopify si votre ERP en a besoin, et cette API pour les prix et les groupes de clients.

Quelles sont les limites de débit ?

Les points d'accès d'upload autorisent une requête par module toutes les 5 minutes, et une requête au-delà de la limite renvoie 429. Le point d'accès Volume Pricing de la version 2 autorise 60 requêtes par période de 60 secondes pour chaque boutique et envoie des en-têtes de limite de débit. Regroupez vos modifications et envoyez une fois après une synchronisation, plutôt qu'après chaque ligne.

Comment authentifier une requête ?

Les points d'accès de la version 1 reçoivent le domaine de votre boutique et la clé d'accès, soit comme accessKey dans le corps, soit dans l'en-tête x-bss-b2b-api-key. Le point d'accès de la version 2 utilise l'en-tête x-api-key. N'envoyez pas la clé comme jeton Bearer : ce format n'est pas pris en charge et la requête échoue avec une erreur 401.

Quelles règles puis-je gérer avec l'API ?

Vous pouvez créer, mettre à jour et supprimer les règles Custom Pricing, Price List et Volume Pricing, ainsi que les règles de codes de remise, les enregistrements du formulaire d'inscription et les règles de limite de commande, avec des opérations en lot sur plusieurs points d'accès. Les points d'accès clients, produits et collections sont des consultations en lecture seule pour construire les charges utiles des règles. Consultez chaque guide pour les opérations exactes.

Que se passe-t-il si j'envoie plus de règles que la capacité ?

Les données de tarification sont stockées dans des métachamps Shopify, avec au maximum 10 clés et 2 000 000 de caractères par clé. Si vos règles activées dépassent cette capacité, l'API enregistre celles qui tiennent et renvoie un rapport partial_success avec un code HTTP 200, en indiquant combien ont été ignorées. Élaguez les règles inactives ou divisez l'ensemble, puis envoyez à nouveau.

Comment voir pourquoi une requête API a échoué ?

Ouvrez la carte Logs and usage sous Advanced Settings > Public API. Elle liste les requêtes récentes avec l'heure, la méthode, le chemin et le statut, avec des onglets pour Custom Pricing, Volume Pricing et Pricing List. Cliquez sur une ligne pour voir la requête et la réponse complètes. Utilisez-la pour vérifier que l'intégration se connecte et pour déboguer les échecs.

Ai-je besoin de l'API, ou un import CSV suffit-il ?

Si les prix changent quelques fois par an, l'import CSV de l'application est plus simple et ne nécessite aucun développeur. La Public API a du sens quand les prix vivent dans un ERP ou un PIM et changent souvent, car une tâche planifiée peut envoyer les modifications sans que personne n'ouvre l'application. L'API nécessite le forfait Platinum.

Installer BSS B2B Solution essai gratuit de 14 jours (plans payants)