API Intelligent Search API

Conheça a plataforma

O que integrar com Intelligent Search API

Descrição técnica preservada da especificação de origem. A versão do contrato ajuda a identificar a API; confirme a disponibilidade atual no fornecedor.

>ℹ️ Onboarding guide > > Check the new Search onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Search and is organized by focusing on the developer's journey. This API is from the VTEX Intelligent Search solution, an alternative to the platform’s native search, as it assists the customer in their purchase journey, and it presents results since the first interaction with the search bar. Index - Get list of the 10 most searched terms - Get list of suggested terms and attributes similar to the search term - Get attempt of correction of a misspelled term - Get list of banners registered for query - Get list of suggested terms similar to the search term - Get list of products for a query - Get list of the possible facets for a given query

Do planejamento à produção

Checklist para integrar Intelligent Search API

1. Defina o fluxo. Identifique quais dados precisam circular, o sistema de origem e o resultado esperado.
2. Leia os requisitos oficiais. Verifique acesso à API, plano necessário, versão e ambiente de testes.
3. Configure o acesso com segurança. Guarde credenciais secretas no servidor e conceda apenas as permissões necessárias. Restrinja chaves públicas conforme a documentação do fornecedor.
4. Teste a primeira requisição. Valide os campos, a paginação e o formato de resposta com dados de teste.
5. Prepare o tratamento de falhas. Considere limites de requisição, retentativas com espera e prevenção de operações duplicadas.
6. Acompanhe a integração. Registre erros sem expor dados sensíveis e monitore alterações na API.