Conteúdo

Criar Banner

Cria um banner

POST

/v1/banners

Escopo

conteudo.escrever

Imagens por URL ou base64 seguem as regras de Enviar Imagem (até 5 MB) e entram na biblioteca de mídia da loja.

Autorização

Authorizationstringobrigatórioheader

Chave da API no formato Bearer hdl_live_.... Crie no painel da loja em Integração › API e webhooks. Saiba mais.

Corpo da requisição

titulostringobrigatóriobody · application/json

imagem_desktopstring | objectobrigatóriobody · application/json

URL da imagem ou { "base64": "..." }.

imagem_mobilestring | objectbody · application/json

Padrão: a de desktop.

linkstringbody · application/json

https://... ou caminho da loja (/categoria...).

ativobooleanbody · application/json

Padrão true.

ordemintegerbody · application/json

iniciostringbody · application/json

fimstringbody · application/json

Resposta

201 — objeto { "dados": {...} } com um Banner.

Erros possíveis

HTTP	código	quando
`401`	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
`401`	`chave_invalida`	Chave inexistente ou revogada.
`403`	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.
`422`	`fornecedor_recusou`	O fornecedor (AliExpress) recusou ou a conta não está conectada; a mensagem traz o motivo.
`413`	`corpo_grande`	Corpo acima de 256 KB (7 MB no envio de imagem, 14 MB em banners).
`422`	`imagem_invalida`	A imagem não pôde ser baixada ou não é JPG, PNG, WEBP ou GIF de até 5 MB.
`422`	`validacao`	Campos inválidos: veja o objeto "campos".

curl --request POST \ --url 'https://api.hoteldaslojas.com.br/v1/banners' \ --header 'Authorization: Bearer <chave>' \ --header 'Content-Type: application/json' \ --data '{"titulo": "Semana do livro", "imagem_desktop": "https://cdn.seuerp.com.br/banners/semana-livro.jpg", "link": "/categoria?filtro=4", "fim": "2026-11-07T23:59:59-03:00"}'

import os, requests resposta = requests.post( "https://api.hoteldaslojas.com.br/v1/banners", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, json={ "titulo": "Semana do livro", "imagem_desktop": "https://cdn.seuerp.com.br/banners/semana-livro.jpg", "link": "/categoria?filtro=4", "fim": "2026-11-07T23:59:59-03:00" }, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/banners'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE'), 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode([ 'titulo' => 'Semana do livro', 'imagem_desktop' => 'https://cdn.seuerp.com.br/banners/semana-livro.jpg', 'link' => '/categoria?filtro=4', 'fim' => '2026-11-07T23:59:59-03:00' ]), ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": { "id": 188, "titulo": "Semana do livro", "imagem_desktop": "https://hoteldaslojas.com.br/base/_uploads/220/2026/10/api-0252351a21f05ad7.webp", "imagem_mobile": "https://hoteldaslojas.com.br/base/_uploads/220/2026/10/api-0252351a21f05ad7.webp", "link": "/categoria?filtro=4", "ativo": true, "ordem": 0, "inicio": null, "fim": "2026-11-07T23:59:59-03:00", "criado_em": "2026-10-28T02:52:35-03:00", "atualizado_em": "2026-10-28T02:52:35-03:00" } }

{ "erro": { "codigo": "sem_permissao", "mensagem": "Esta chave não tem o escopo \"pedidos.ler\". Crie uma chave com esse escopo no painel da loja (Integração › API).", "request_id": "req_95f4a872c180063c" } }