Saltar para o conteúdo 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.

Este guia mostra como integrar resultados de leilão do Topsort com seu índice Algolia existente, permitindo que produtos orgânicos e promovidos sejam listados no mesmo fluxo. Algolia é um mecanismo de busca poderoso que fornece resultados rápidos e relevantes para navegar em catálogos. Ao integrar Algolia com Topsort, podemos sincronizar seu catálogo diretamente no Topsort, sem precisar de integrações de catálogo extras. A integração também permitirá que você priorize produtos promovidos nos resultados orgânicos retornados pelo Algolia. Confira a integração do Proxy do Topsort para mais detalhes.

Como Funciona

1

Pré-requisitos

Para integrar o Topsort com Algolia, certifique-se de cumprir com esses pré-requisitos:
  • Seu catálogo de produtos está armazenado em um índice Algolia.
  • Você está consultando Algolia usando o SDK Algolia.
2

Criar Chave de API

Crie uma chave de API Algolia com as seguintes permissões: search, browse, listIndexes (permissões adicionais como addObject e deleteObject podem ser necessárias dependendo de como você gerencia as atualizações do seu índice).
  • A permissão browse permite o download de todo o seu catálogo.
  • A permissão listIndexes permite que o Topsort verifique a data da última modificação do índice para evitar atualizações desnecessárias
3

Compartilhar Detalhes do Índice

Entre em contato com o suporte do Topsort e compartilhe o nome do seu índice Algolia. Isso permite que o Topsort configure e comece a importar seu catálogo.
4

Configurar Proxy do Topsort

Atualize a configuração do seu SDK Algolia para apontar para o Proxy do Topsort. Isso permitirá que o Topsort priorize produtos promovidos nos resultados orgânicos retornados pelo Algolia.
import algoliasearch from 'algoliasearch/lite';

const client = algoliasearch('SeuApplicationID', 'SuaChaveDeAPIDeEscrita', {
  hosts: [{ url: 'meuslug-sandbox.topsort.workers.dev' }],
});
const index = client.initIndex('nome_do_seu_indice');

Resultados de Leilão e Rastreamento de Eventos

Os produtos promovidos priorizados na resposta do Proxy do Topsort terão um parâmetro resolvedBidId que identifica exclusivamente o leilão daquele produto. Você pode usá-lo para marcar visualmente o produto como “Promovido” para o usuário final. O resolvedBidId também é necessário para identificar o vencedor do leilão ao reportar eventos (impressões, cliques, compras). Confira nossa documentação de Rastreamento de Eventos para mais detalhes.