VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Conteúdo da vitrine

FAQ da plataforma

Lista os artigos publicados da base de ajuda da plataforma Venddor e faz busca por pergunta.

O FAQ é a base de conhecimento de ajuda de uso da plataforma: "como rastrear meu pedido", "como trocar a senha". Ela é mantida pela Venddor e é a mesma para todas as lojas. Não é o FAQ da sua loja: perguntas sobre os seus produtos e políticas ficam em Páginas.

Pontos principais
  • Conteúdo global: não depende da loja da chamada. Duas lojas diferentes recebem exatamente os mesmos artigos.
  • A lista só traz artigos publicados e sai com cache de 60 segundos.
  • A busca devolve até 5 trechos, do mais ao menos relevante, e ordena por score (maior é melhor).
  • Uma loja nova pode ter o FAQ vazio. Trate articles: [] e results: [] como estado normal.
GET/api/v1/storefront/faqPública

Listar os artigos do FAQ

Exemplo de requisição

Resposta

200Artigos

Campos da resposta

articlesarray
Artigos publicados, do mais recentemente alterado para o mais antigo. [] quando não há nenhum.
articles[].idstring
Id do artigo.
articles[].titlestring
Título (a pergunta).
articles[].bodystring
Texto da resposta.
articles[].tagsarray
Etiquetas do artigo (lista de textos).
articles[].langstring
Idioma do artigo, por exemplo pt-BR. A rota não filtra por idioma: filtre no cliente se precisar.
articles[].statusstring
Aqui sempre published.
articles[].chunk_countinteger
Em quantos trechos o texto foi dividido para a busca.
articles[].created_atstring
Criação (RFC 3339).
articles[].updated_atstring
Última alteração (RFC 3339).
totalinteger
Quantidade de artigos.

Erros

StatusQuandoCorpo
500Falha ao ler a base de ajuda.{"error":"..."}
GET/api/v1/storefront/faq/searchPública

Buscar no FAQ

Parâmetros de consulta

qstringobrigatório
Pergunta ou palavras-chave. Sem q, ou só com espaços, devolve results: [] sem erro.
200Resultados

Campos da resposta

resultsarray
Até 5 trechos, do mais relevante ao menos. [] quando nada combina.
results[].document_idstring
Id do artigo de onde veio o trecho (articles[].id).
results[].titlestring
Título do artigo.
results[].sectionstring
Cabeçalho mais próximo do trecho, quando existe. Ausente quando não há.
results[].chunk_textstring
Trecho do texto que responde à busca.
results[].scorenumber
Relevância. Quanto maior, mais relevante. A escala depende do modo de busca; use só para ordenar, nunca como porcentagem.

Erros

StatusQuandoCorpo
500Falha na busca.{"error":"..."}
Busca tolerante

A busca entende perguntas inteiras ("como faço para trocar a senha?"), mas, se o serviço de busca por significado estiver indisponível, a plataforma cai para uma busca simples por palavras e a ordem pode piorar. Mostre sempre o title e deixe o cliente abrir o artigo completo na lista.

Veja também

  • Páginas
  • Mensagens do cliente
Anterior
Comentários do blog
Próxima
Formulários
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Erros
  • Veja também
bash
curl "$BASE_URL/api/v1/storefront/faq"
bash
curl -G "$BASE_URL/api/v1/storefront/faq/search" --data-urlencode "q=como rastrear meu pedido"
json
{
  "articles": [
    {
      "id": "5b1f0c3a-8d2e-4f6a-9b7c-3e4d5f6a7b8c",
      "title": "Como acompanhar meu pedido",
      "body": "Acesse Minha conta > Pedidos e clique no número do pedido para ver o rastreio.",
      "tags": ["pedidos", "rastreio"],
      "lang": "pt-BR",
      "status": "published",
      "chunk_count": 1,
      "created_at": "2026-08-01T12:00:00Z",
      "updated_at": "2026-09-15T09:30:00Z"
    }
  ],
  "total": 1
}
json
{
  "results": [
    {
      "document_id": "5b1f0c3a-8d2e-4f6a-9b7c-3e4d5f6a7b8c",
      "title": "Como acompanhar meu pedido",
      "section": "Rastreio",
      "chunk_text": "Acesse Minha conta > Pedidos e clique no número do pedido para ver o rastreio.",
      "score": 0.82
    }
  ]
}