logo

Potions Data API

💡
Pour utiliser cette API, vous aurez besoin d’un token d’authentification ainsi que de votre site_id. Ces deux informations sont prĂ©sentes dans le cowork fourni par Potions.
Pour authentifier vos requĂȘtes, il faut rajouter un header Authorization contenant le token d’API Ă  chaque requĂȘte.
Pour s’authentifier dans la documentation, il faut cliquer sur le bouton “Authorize” puis rentrer le token. Le header contenant le token sera ensuite automatiquement rajoutĂ© Ă  chaque requĂȘte.

Lien vers la documentation technique de l’API

Potions Experiences API - Swagger UI
Vous pouvez utiliser le site_id : 504 et le token Z8gib1CBfF2xQyrYVb0PewD4b7KThm8o pour accĂ©der Ă  des donnĂ©es d’exemple.

PrĂ©sentation de l’API Data

L’API Data vous donne un accĂšs programmatique aux donnĂ©es de Potions. Elle permet notamment de rĂ©cupĂ©rer des listes de produits en fonction d’un contexte qui lui sera passĂ© en paramĂštres.

Guide de démarrage rapide

Il suffit de quelques lignes de code pour appeler l'API afin de récupérer votre premiÚre liste de produits. Vous trouverez ci-dessous un exemple dans plusieurs langages de programmation.
Python
JavaScript
Curl

Endpoints disponibles

L’accĂšs aux donnĂ©es Potions se fait au travers d’endpoints sur les serveurs Potions.
L’endpoint principal est le endpoint experience/ permettant de rĂ©cupĂ©rer programmatiquement les produits listĂ©s dans une expĂ©rience
GET https://client.experiences.get-potions.com/v1/{siteId}/experience/{experienceId}?variables={query}
Les autres endpoints sont optionnels et ne sont mis à disposition que si nécessaire.

experience/

Une expérience est un emplacement visible de vos clients et géré via Potions.
Chaque expĂ©rience dispose d’un nom et d’un id unique, par exemple :
  • nom : recommandations de produits - ajout panier
  • id : 125749
Suivant le type d’expĂ©rience, l’id d’expĂ©rience se retrouve sur votre site, dans votre outil d’e-mail, votre CMS, vos analytiques, le Lab Potions

Il constitue Ă©galement le point d’entrĂ©e de l’API Potions dans le cas d’expĂ©rience rĂ©cupĂ©rant des listes de produits recommandĂ©s ou des tris de pages catĂ©gories (e-merchandizing)
Pour rĂ©cupĂ©rer une liste de produits Ă  partir d’un id d’expĂ©rience, l’endpoint Ă  appeler est le suivant : GET https://client.experiences.get-potions.com/v1/{siteId}/experience/{experienceId}{queryString}
Avec :
  • siteId : l’id de votre site, fourni par Potions
  • experienceId : l’id d’expĂ©rience fourni par Potions, il diffĂšrera pour chaque emplacement
  • queryString contenant ces paramĂštres :
    • variables : un objet JSON contenant des variables contextuelles facultatives. Certaines variables sont nĂ©cessaires pour appeler des expĂ©riences, l’information vous sera alors transmise par Potions.
      • product_id : l’id du produit
      • product_ids : les ids des produits de la page
      • category_id : l’id de la catĂ©gorie
      • cart_product_ids : les ids des produits ajoutĂ©s au panier
      • 

Cet endpoint est aussi disponible en POST :
POST https://client.experiences.get-potions.com/v1/{siteId}/experience/{experienceId}
Avec :
  • siteId : l’id de votre site, fourni par Potions
  • experienceId : l’id d’expĂ©rience fourni par Potions, il diffĂšrera pour chaque emplacement
  • Un body en JSON contenant des variables contextuelles facultatives. Certaines variables sont nĂ©cessaires pour appeler des expĂ©riences, l’information vous sera alors transmise par Potions.
    • product_id : l’id du produit
    • product_ids : les ids des produits de la page
    • category_id : l’id de la catĂ©gorie
    • cart_product_ids : les ids des produits ajoutĂ©s au panier
Exemples d’utilisation

(optionnel) collections/