shop.banners.list
Banners ativos dentro da janela de exibição, em ordem de prioridade e criação; inclui configuração do carrossel.
Exemplos seguros e fictícios. O domínio
example.invalid e a credencial demonstrativa abaixo não funcionam. Use o token real somente no servidor da sua integração e nunca o inclua em páginas públicas.Parâmetros
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplo fictício |
|---|---|---|---|---|
slot | string | Opcional | Posição exata do banner. Sem slot, retorna todas as posições. | "home" |
Exemplos fictícios
Os exemplos documentam o formato; eles não executam nenhuma operação.
Requisição
cURL demonstrativo
curl --request POST \
'https://example.invalid/api/v1/CREDENCIAL_FICTICIA_SEM_VALOR/shop.banners.list' \
--header 'Content-Type: application/json' \
--data '{"slot":"home"}'Corpo JSON
{
"slot": "home"
}Resposta HTTP 200
{
"ok": true,
"method": "shop.banners.list",
"result": {
"banners": [
{
"id": "44444444-4444-4444-8444-444444444444",
"slot": "home",
"titulo": "Banner de demonstração",
"imagem_url": "https://assets.example.com/banner.png",
"link_url": "https://loja.example.com/catalogo",
"ordem": 0
}
],
"carrossel": {
"efeito": "slide",
"intervalo_ms": 5000,
"transicao_ms": 600,
"autoplay": true,
"laco": true,
"mostrar_setas": true,
"mostrar_pontos": true,
"pausar_no_hover": true
}
}
}Erros
| HTTP | Código | Condição |
|---|---|---|
| 403 | TOKEN_NO_COMPANY | Token sem empresa associada. |
Consulte também os erros globais e limites.
Observações
- carrossel pode ser null quando ausente, inválido ou indisponível. O consumidor deve ter fallback.
- Configuração administrativa admite efeitos slide, fade, zoom, cover e none; intervalo de 1000 a 30000 ms e transição de 0 a 3000 ms.
- Caminhos de imagem relativos são prefixados pela base pública configurada no servidor.