Listar banners
Os banners da vitrine, na ordem em que aparecem.
Exemplo
curl "https://api.otlshoes.com.br/v1/loja-hub/banners" \
-H "Authorization: Bearer otl_prod_SEU_TOKEN"curl "https://api-sandbox.otlshoes.com.br/v1/loja-hub/banners" \
-H "Authorization: Bearer otl_sbx_SEU_TOKEN"const resposta = await fetch('https://api.otlshoes.com.br/v1/loja-hub/banners', {
headers: {
Authorization: 'Bearer otl_prod_SEU_TOKEN',
},
});
if (!resposta.ok) {
const { erro } = await resposta.json();
throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();const resposta = await fetch('https://api-sandbox.otlshoes.com.br/v1/loja-hub/banners', {
headers: {
Authorization: 'Bearer otl_sbx_SEU_TOKEN',
},
});
if (!resposta.ok) {
const { erro } = await resposta.json();
throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();<?php
$ch = curl_init('https://api.otlshoes.com.br/v1/loja-hub/banners');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer otl_prod_SEU_TOKEN',
]);
$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) {
throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}<?php
$ch = curl_init('https://api-sandbox.otlshoes.com.br/v1/loja-hub/banners');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer otl_sbx_SEU_TOKEN',
]);
$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status >= 400) {
throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}import requests
resposta = requests.get(
"https://api.otlshoes.com.br/v1/loja-hub/banners",
headers={
"Authorization": "Bearer otl_prod_SEU_TOKEN",
},
timeout=30,
)
if not resposta.ok:
erro = resposta.json()["erro"]
raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()import requests
resposta = requests.get(
"https://api-sandbox.otlshoes.com.br/v1/loja-hub/banners",
headers={
"Authorization": "Bearer otl_sbx_SEU_TOKEN",
},
timeout=30,
)
if not resposta.ok:
erro = resposta.json()["erro"]
raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()Testar agora no ambiente de testes
A chamada é feita de verdade, do seu navegador para a API de testes (https://api-sandbox.otlshoes.com.br/v1). Use um token otl_sbx_…: ele fica só nesta aba, e some ao fechá-la. Token de produção não é aceito aqui.
Resposta
{
"banners": [
{
"id": "cmh1b2c3d0001",
"imagemUrl": "https://cdn.otlshoes.com.br/otl-catalog/hub/banners/inverno.webp",
"descricao": "Promoção de inverno",
"link": "https://hubshoes.com.br/joao-calcados?marca=casual",
"posicao": 0,
"ativo": true,
"criadoEm": "2026-09-10T10:00:00-03:00"
}
]
}
| Campo | Tipo | Descrição |
|---|---|---|
banners[].id | texto | O identificador do banner. |
banners[].imagemUrl | texto | A imagem, já convertida para WebP. |
banners[].descricao | texto | Texto alternativo da imagem. Pode ser null. |
banners[].link | texto | Para onde o banner leva. Pode ser null. |
banners[].posicao | inteiro | A ordem no carrossel, a partir de 0. |
banners[].ativo | booleano | false = guardado, mas fora da vitrine. |
banners[].criadoEm | data | Quando foi enviado. |
A lista traz também os banners desligados (ativo: false).
Erros possíveis
| HTTP | codigo |
Quando |
|---|---|---|
| 403 | LOJA_HUB_NAO_LIBERADA |
A OTL ainda não liberou a loja no HUB para este parceiro |
| 403 | ESCOPO_INSUFICIENTE |
A integração não tem loja-hub:ler |
