Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.topsort.com/llms.txt

Use this file to discover all available pages before exploring further.

Le proxy est une couche intermédiaire entre le backend de la marketplace et le serveur de résultats (le serveur d’Algolia, par exemple). Il agit comme un pont entre la marketplace, le moteur de recherche et Topsort. Cela permet au proxy d’intégrer les gagnants d’enchères récupérés depuis Topsort dans la réponse fournie par le moteur de recherche, et de retourner la réponse finale fusionnée à la marketplace. Le proxy est compatible avec la plupart des stacks technologiques, et il a été testé avec des plateformes comme VTEX, Algolia et Salesforce.

​
Comment utiliser le proxy

Pour commencer à utiliser le proxy, vous devez simplement changer le nom d’hôte dans votre appel API existant, de votre catalogue ou moteur de recherche vers notre proxy. Par exemple, changez de : 
https://api.site.com/catalog/query?taxonomy=clothes
à : 
https://site.proxy.topsort.com/catalog/query?taxonomy=clothes
Et nous nous occupons du reste. Nous envoyons la requête au moteur d’enchères de Topsort et au catalogue ou moteur de recherche. Si l’un des produits renvoyés par le catalogue ou le moteur de recherche est promu, nous l’indiquerons dans la réponse fusionnée que nous construirons, qui sera renvoyée à la marketplace. Actuellement, le proxy prend en charge les réponses application/json. La prise en charge de XML et GraphQL est prévue.

​
Comment les produits promus sont ajoutés

Considérez la requête suivante, qui récupère les produits de la taxonomie ‘office’ : 
GET https://api.site.com/catalog/query?taxonomy=office
La réponse du catalogue ou du serveur de recherche sans l’intégration du proxy de Topsort : 
{
  "products": [
    { "id": "1", "name": "Imprimante laser couleur haute vitesse" },
    { "id": "2", "name": "Bureau debout réglable en hauteur" },
    { "id": "3", "name": "Chaise de bureau pivotante ergonomique" },
    { "id": "4", "name": "Combo clavier et souris sans fil" },
    { "id": "5", "name": "Tableau blanc magnétique avec ensemble de marqueurs" }
  ]
}
Après fusion des produits promus dans la réponse : 
{
  "products": [
    {
      "id": "3",
      "name": "Chaise de bureau pivotante ergonomique",
      "rank": 1,
      "resolvedBidId": "..."
    },
    {
      "id": "6",
      "name": "Classeur à tiroirs multiples",
      "rank": 2,
      "resolvedBidId": "..."
    },
    { "id": "1", "name": "Imprimante laser couleur haute vitesse" },
    { "id": "2", "name": "Bureau debout réglable en hauteur" },
    { "id": "4", "name": "Combo clavier et souris sans fil" }
  ],
  "topsort": {
    "winners": [
      { "rank": 1, "type": "product", "id": "3", "resolvedBidId": "..." },
      { "rank": 2, "type": "product", "id": "6", "resolvedBidId": "..." }
    ]
  }
}

​
Comprendre les nouveaux champs

  • rank : La position du produit promu dans l’enchère.
  • resolvedBidId : Un ID unique utilisé pour suivre le produit dans les analyses.
Un nouvel objet nommé topsort est ajouté au niveau racine uniquement lorsque des produits promus sont inclus.

​
Comment suivre les événements

Si vous utilisez la bibliothèque analytics.js de Topsort ou l’API Events, utilisez les champs product id et resolvedBidId pour suivre les interactions utilisateur : 
<div class="product" data-ts-product="3" data-ts-resolved-bid="resolvedBidId">
  ...
</div>

​
Fonctionnalités du proxy

  • Mise en cache des réponses : Réduit la latence en mettant en cache les réponses réussies du catalogue ou du moteur de recherche.
  • Mode staging : Permet les tests avant la mise en production.
  • Prise en charge de la synchronisation du catalogue : Envoie des informations pour maintenir le catalogue de Topsort à jour.
  • Journalisation intégrée : Collecte des données sur les produits, les enchères et les performances.