VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Venddor Intelligence na vitrine

Configuração do assistente

Diz se o assistente de compras está ligado e traz a saudação, as sugestões e as capacidades.

Chame esta rota quando a página carrega para decidir se mostra o botão do assistente e com que textos.

GET/api/v1/storefront/intelligence/configPública

Configuração do assistente da vitrine

Não exige token. Devolve a configuração para o cliente atual, por isso a resposta nunca é guardada em cache (Cache-Control: private, no-store): a saudação e as sugestões mudam para quem compra como empresa (B2B).

Cabeçalhos

Authorizationstring
Bearer <token> do cliente, se houver. Opcional.
Accept-Languagestring
Idioma preferido, usado se não houver o cookie venddor_language.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/storefront/intelligence/config"

Resposta

200Configuração
json
{
  "enabled": true,
  "flags": { "voice": true, "image": true, "snap": true, "proactive": true },
  "locale": "pt-BR",
  "greeting": "Oi! Sou seu copiloto de compras. Pergunte, fale 🎤 ou mande uma foto 📷.",
  "suggestions": ["Tem parecido mais barato?", "Isso é um bom negócio?", "Me ajuda a escolher", "Cadê meu pedido?"],
  "brand_name": "Venddor Intelligence"
}

Campos da resposta

enabledboolean
true quando a loja ligou o assistente da vitrine. Mostre o botão só nesse caso.
flagsobject
Capacidades disponíveis. Todas valem false quando enabled é false.
flags.voiceboolean
O cliente pode falar e ouvir (veja Voz). Depende de um segundo interruptor da loja.
flags.imageboolean
O cliente pode anexar uma foto à conversa.
flags.snapboolean
Busca de produtos por foto disponível.
flags.proactiveboolean
Avisos contextuais disponíveis.
localestring
Idioma resolvido para esta chamada (pt-BR, en ou es).
greetingstring
Frase de abertura no idioma do cliente.
suggestionsstring[]
Quatro perguntas de exemplo. Para compradores B2B (conta de empresa ou pessoa jurídica) as sugestões falam de preço de contrato e de pedidos recorrentes.
brand_namestring
Nome de exibição do assistente nesta loja. O padrão é Venddor Intelligence; a loja pode trocá-lo pelo da própria marca.

Erros

StatusQuandoCorpo
200Sempre, também com o assistente desligado e em loja que exige login para navegar: a rota é pública e não tem resposta de erro própria.{"enabled":false,"flags":{...}}
Um assistente desligado ainda responde a esta rota

Com o assistente desligado a rota continua respondendo 200, com enabled: false e todas as flags falsas. Não trate falha de rede e enabled: false do mesmo jeito: só o segundo significa "esconda o botão".

Veja também

  • Conversar
  • Venddor Intelligence na vitrine
Anterior
Venddor Intelligence na vitrine
Próxima
Conversar com o assistente
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também