Cet article présente les étapes de téléchargement de produits via l'API Scantrust. Vous aurez d'abord besoin d'un jeton UAT avec les autorisations suivantes :
- produit_créer
- supprimer le produit
- édition_produit
- vue du produit
Vous aurez également besoin d'au moins une marque configurée dans le portail : chaque produit que vous créez doit être attribué à une marque.
Important:
Pour accéder à l'API REST Scantrust, vous pouvez utiliser une plateforme d'API comme Postman, la plateforme d'API la plus populaire au monde, avec plus de 17 millions d'utilisateurs et 500 000 organisations dans le monde. Cet outil offre un environnement flexible et collaboratif qui vous permet de concevoir, développer, documenter et tester vos API plus rapidement.
Vous pouvez essayer l'application Web ou télécharger et installer cette application à partir de ce lien: https://www.postman.com/downloads/ Dans tous les cas, vous devez vous inscrire avec une adresse email valide.
Remarque : Dans le contexte de Scantrust, Postman ne doit être utilisé qu'à des fins de test. Il ne doit pas être utilisé dans des scénarios réels ni pour des implémentations de projets.
Étapes pour configurer Postman :
1. Ouvrez Postman. Sur la page d'accueil, vous devriez voir ce qui suit :
2. Ensuite, cliquez sur l'onglet « Espaces de travail » dans le coin supérieur gauche :
3. Cliquez ensuite sur l’option « Mon espace de travail » :
4. Une fois dans votre espace de travail, cliquez sur le signe « + » comme suit :
5. Après cela, un nouvel onglet apparaîtra avec une requête API préconfigurée: GET :
6. Il est maintenant important de configurer l'autorisation API. Pour cela, cliquez sur l'onglet « Autorisation » :
7. Ensuite, cliquez sur la section « Type » et sélectionnez l'option « Clé API », comme suit:
8. Maintenant, tapez le mot « Autorisation » dans le champ clé, puis copiez votre jeton UAT depuis le portail ST et collez-le dans le champ « Valeur », y compris les caractères UAT. UAT [jeton tu], en laissant une barre d'espace entre la chaîne UAT et le jeton:
9. Ensuite, allez dans l'onglet « Corps », sélectionnez « raw » et sélectionnez « JSON » :
Étapes pour télécharger des produits avec l'API Scantrust
1. Vous êtes maintenant prêt à télécharger un produit via l'API Scantrust. Pour commencer, définissez la requête API sur POST. Cliquez sur le bouton de requête et sélectionnez l'option « POST ».
2. Pour configurer cette requête, vous devrez saisir l'URL, qui dans ce cas est la suivante: https://api.scantrust.com/api/v2/products/:
3. Ensuite, dans l’onglet Corps, saisissez ce qui suit :
{
"sku": "PR3",
"marque": 2841,
"nom": "Produit trois",
"description": "Le troisième produit d'une série de nombreux autres.",
"client_url": "http://www.examplebrand.com/productone",
« campagne » : 575
}
Où « SKU » désigne le SKU unique du produit dans l'entreprise, « brand » désigne l'identifiant de la marque (entier) ou sa référence (chaîne de caractères), et « name » désigne le nom du produit. Tous ces éléments sontchamps obligatoirespour établir la demande.
D'autre part, le champ « description » contient une brève description du produit ; l'URL client contient l'URL du produit, qui peut être utilisée pour rediriger les codes si aucune campagne n'est active pour ce produit ; et le champ « image » permet d'inclure une image du produit, généralement utilisée sur les pages de destination STC. Si cette option n'est pas définie, l'image de marque et l'image de campagne seront utilisées, c'est-à-dire l'identifiant d'une campagne existante au sein de l'entreprise à laquelle ce produit doit être ajouté. Ce sont tous des champs facultatifs.
4. Une fois votre script de code terminé, nous pouvons cliquer sur le bouton SOUMETTRE :
5. Lorsqu'un produit est publié avec succès, la réponse ressemble à ceci :
Si le téléchargement a réussi, la réponse d'état doit être 200 ou 201. Vous pouvez ensuite vérifier la création de ce nouveau produit dans le portail Scantrust.
Étapes pour télécharger des produits avec l'API Scantrust
Vous aurez besoin d'un jeton UAT avec les autorisations suivantes :
- product_view
Dans ce cas, nous récupérerons les informations sur les produits pour une entreprise entière ou un produit spécifique en utilisant uniquement le SKU du produit.
1. Veuillez vous rendre dans votre espace de travail Postman et ouvrir un nouvel onglet avec le signe « + » :
2. Ensuite, allez dans l’onglet « Corps » et sélectionnez « aucun » :
3. Afin de télécharger les informations sur le produit, vous devrez configurer une requête GET en saisissant l'URL, qui dans ce cas est la suivante: https://api.scantrust.com/api/v2/products/:
4. Cliquez ensuite sur le bouton ENVOYER:
5. Lorsque la demande d'API a réussi, la réponse d'état doit être 200 et la réponse sera fournie:
Cette réponse inclut tous les produits répertoriés dans votre entreprise, avec des attributs spécifiques tels que le SKU, le nom, la description, la marque, etc.
6. Si vous souhaitez connaître des informations spécifiques sur le produit, nous devons configurer la requête GET en saisissant l'URL, qui dans ce cas est la suivante: https://api.scantrust.com/api/v2/products/?sku_exact=[SKU]:
Dans ce cas, la réponse inclut uniquement les informations sur le produit pour l’ID que vous avez spécifié dans l’URL.
Commentaires