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

Imagens e anexos de produto

Como a plataforma guarda as fotos e os arquivos de um produto, e as rotas para ajustar, trocar a principal, apagar e melhorar imagens com IA.

Cada produto tem uma galeria de imagens (a primeira, ou a marcada como principal, aparece na listagem e na vitrine) e, opcionalmente, anexos: arquivos para baixar, como manual em PDF, ficha técnica ou tabela de medidas. Esta seção cobre as operações que agem sobre uma imagem ou um anexo pelo id deles. Para adicionar ou reordenar imagens e anexos de um produto (rotas com products/{id} no caminho), veja a seção de produtos.

Pontos-chave
  • Imagens e anexos têm id próprio (UUID). Pegue o id na lista do produto (GET /api/v1/admin/products/{id}/images e .../attachments).
  • Toda imagem tem position (0, 1, 2...) e uma só pode ser a principal (is_primary). Apagar a principal promove automaticamente a primeira restante.
  • As duas ferramentas de IA (remover fundo e "profissionalizar") só devolvem a imagem processada. Nada é salvo: você grava o resultado depois, como uma imagem nova.
  • A plataforma não recebe o arquivo do anexo: o anexo guarda uma URL (file_url) de um arquivo que você já enviou.
  • Escrever exige o privilégio manage_catalog.

Como funciona

Galeria de imagens

Enviar arquivo→Adicionar à galeria→Ajustar texto e ordem→Definir a principal

A galeria é ordenada por position. Ao apagar uma imagem, as seguintes sobem uma posição, então as posições continuam contíguas. Definir a imagem principal renova o carimbo de atualização do produto e o índice de busca, para a vitrine mostrar a foto nova em seguida.

Edição com IA

O editor de imagem do painel envia a imagem atual e recebe de volta os bytes da imagem melhorada. O fluxo é: você envia o arquivo, a rota devolve o PNG processado, você confere e então grava no produto pelas rotas de upload e de galeria.

Conceitos-chave

Id de imagem e id de produto

Os caminhos desta seção usam o id da imagem. Um id de produto no lugar dá 404. Um valor que não é UUID dá 500 com uma mensagem em português (veja os erros).

Campos de uma imagem

CampoTipoDescrição
idUUIDId da imagem.
image_urlstringCaminho ou URL do arquivo.
alt_textstringTexto alternativo, para acessibilidade e SEO.
positioninteiroOrdem na galeria, a partir de 0.
is_primarybooleanoSe é a imagem de capa.

Endpoints

Método e caminhoPara que serveAutenticaçãoPágina
PUT /api/v1/admin/images/{id}Altera texto, posição ou principaladministradorImagens
PUT /api/v1/admin/images/{id}/primaryDefine a imagem principaladministradorImagens
DELETE /api/v1/admin/images/{id}Apaga a imagemadministradorImagens
DELETE /api/v1/admin/product-images/{id}Mesma exclusão, caminho da plataforma antigaadministradorImagens
POST /api/v1/admin/images/ai/removebgRemove o fundoadministradorImagens com IA
POST /api/v1/admin/images/ai/professionalizeRefaz como foto de estúdioadministradorImagens com IA
PUT /api/v1/admin/attachments/{attachmentId}Altera um anexoadministradorAnexos
DELETE /api/v1/admin/attachments/{attachmentId}Apaga um anexoadministradorAnexos

Erros comuns

  • Enviar o id do produto no lugar do id da imagem. Dá 404 image not found.
  • Mandar PUT /images/{id} com corpo vazio {}. Responde 500 com no fields to update: envie ao menos um campo.
  • Esperar que as rotas de IA gravem a imagem. Elas só devolvem o arquivo processado.
  • Enviar JSON nas rotas de IA. Elas esperam multipart/form-data com o campo image.
  • Atualizar um anexo mandando só um campo. description e position são sempre regravados (veja a página de anexos).
  • Passar um valor que não é UUID. Dá 500, não 400.

Próximos passos

Imagens
Principal, texto alternativo e exclusão.
Imagens com IA
Remover fundo e padronizar fotos.
Anexos
Arquivos para download.
Anterior
Anexos do produto
Próxima
Imagens do produto
Nesta página
  • Como funciona
  • Galeria de imagens
  • Edição com IA
  • Conceitos-chave
  • Id de imagem e id de produto
  • Campos de uma imagem
  • Endpoints
  • Erros comuns
  • Próximos passos