Saltar para o conteúdo principal
O proxy é uma camada intermediária entre o backend do marketplace e o servidor de resultados (servidor do Algolia, por exemplo). Ele atua como uma ponte entre o marketplace, o mecanismo de busca e o Topsort. Isso permite que o proxy ingira os vencedores do leilão recuperados do Topsort na resposta fornecida pelo mecanismo de busca e retorne a resposta mesclada final ao marketplace. O proxy é compatível com a maioria dos stacks tecnológicos e foi testado com plataformas como VTEX, Algolia e Salesforce.

Como Usar o Proxy

Para começar a usar o proxy, você só precisa alterar o hostname na sua chamada de API existente, do seu catálogo ou mecanismo de busca para nosso proxy. Por exemplo, mude de:
https://api.site.com/catalog/query?taxonomy=clothes
para:
https://site.proxy.topsort.com/catalog/query?taxonomy=clothes
E nós cuidamos do resto. Enviamos a solicitação para o motor de leilão do Topsort e para o catálogo ou mecanismo de busca. Se algum dos produtos retornados pelo catálogo ou mecanismo de busca for promovido, indicaremos isso na resposta mesclada que construiremos, que será retornada ao marketplace. Atualmente, o proxy suporta respostas application/json. Suporte para XML e GraphQL está planejado.

Como Produtos Promovidos São Adicionados

Considere a seguinte solicitação, que busca produtos da taxonomia ‘office’:
GET https://api.site.com/catalog/query?taxonomy=office
A resposta do catálogo ou servidor de busca sem a integração do proxy do Topsort:
{
  "products": [
    { "id": "1", "name": "Impressora Laser Colorida de Alta Velocidade" },
    { "id": "2", "name": "Mesa de Pé Ajustável" },
    { "id": "3", "name": "Cadeira de Escritório Giratória Ergonômica" },
    { "id": "4", "name": "Combo de Teclado e Mouse Sem Fio" },
    { "id": "5", "name": "Quadro Branco Magnético com Conjunto de Marcadores" }
  ]
}
Após mesclar produtos promovidos na resposta:
{
  "products": [
    {
      "id": "3",
      "name": "Cadeira de Escritório Giratória Ergonômica",
      "rank": 1,
      "resolvedBidId": "..."
    },
    {
      "id": "6",
      "name": "Armário de Arquivo com Múltiplas Gavetas",
      "rank": 2,
      "resolvedBidId": "..."
    },
    { "id": "1", "name": "Impressora Laser Colorida de Alta Velocidade" },
    { "id": "2", "name": "Mesa de Pé Ajustável" },
    { "id": "4", "name": "Combo de Teclado e Mouse Sem Fio" }
  ],
  "topsort": {
    "winners": [
      { "rank": 1, "type": "product", "id": "3", "resolvedBidId": "..." },
      { "rank": 2, "type": "product", "id": "6", "resolvedBidId": "..." }
    ]
  }
}

Entendendo os Novos Campos

  • rank: A posição do produto promovido no leilão.
  • resolvedBidId: Um ID único usado para rastrear o produto em análises.
Um novo objeto chamado topsort é adicionado no nível raiz apenas quando produtos promovidos são incluídos.

Como Rastrear Eventos

Se você usar a biblioteca analytics.js do Topsort ou a API de Eventos, use os campos product id e resolvedBidId para rastrear interações do usuário:
<div class="product" data-ts-product="3" data-ts-resolved-bid="resolvedBidId">
  ...
</div>

Recursos do Proxy

  • Cache de Resposta: Reduz a latência armazenando em cache respostas bem-sucedidas do catálogo ou mecanismo de busca.
  • Modo de Staging: Permite testar antes de entrar em produção.
  • Suporte para Sincronização de Catálogo: Envia informações para manter o catálogo do Topsort atualizado.
  • Logging Integrado: Coleta dados sobre produtos, leilões e desempenho.

Precisa de ajuda com sua integração Topsort?

Fale conosco, a equipe de engenharia de integrações.Entre em contato através do seu canal de mensagens dedicado ou em support@topsort.com.Se você ainda não é cliente, agende uma demo com nossa equipe de vendas.