Pular para o conteúdo principal

Imagens

Upload de Imagem

Este endpoint é utilizado para enviar a imagem representativa de um item em lojas que operam no modelo de Cardápio.

Importante: O envio da imagem via API não garante sua publicação imediata no aplicativo. Uma vez que o upload é realizado, a imagem entra em um fluxo de auditoria e precisa ser aprovada pelo time do aiqfome. Esta análise garante que as fotos estejam em conformidade com os padrões de qualidade e segurança da plataforma.


POST
/images/{store_id}/item/{uuid}

Parâmetros da URL

ParâmetroObrigatórioDescrição
store_idID da loja proprietária do item.
uuidIdentificador único (UUID) do item que receberá a imagem.
Parâmetros do Corpo (Body - Multipart/Form-Data)

CampoTipoObrigatórioDescrição
imagefile

Arquivo de imagem (deve ser um formato de imagem válido).
Formatos: .png, .jpg, .jpeg.
Dimensões Mínimas: 400 x 400 px.
Dimensões Máximas: 1200 x 800 px.

highlightedbooleanDefine se a imagem será o destaque do item.

Consulta de Imagem e Status de Aprovação

Este endpoint permite visualizar a URL da imagem vinculada a um item e o seu respectivo status no processo de aprovação no aiqfome.

GET
/images/{store_id}/item/{uuid}

Payload Consulta de Item com Imagem e Status de Aprovação
{
"success": true,
"data": {
"url": "https://test-aqf-painel.s3.amazonaws.com/itens/5f6ddd98858c734962c/ri5QurRSaEQpNjijU4CqkaXA90TJsaZT9ufru81J.png",
"highlighted": true,
"status": "imagem aguardando aprovação",
"status_reason": null
}
}
Payload Payload Consulta de Item sem Imagem
{
"success": false,
"data": {
"message": "este item não tem uma imagem",
"track_id": "694AA76675527",
"errors": {
"item_without_image": [
"este item não tem uma imagem"
]
},
"error_code": "APP_605B688A24228"
}
}
Resposta de Sucesso (Status Code 200)

O retorno apresenta o objeto data com as informações da mídia e o parecer da curadoria.


CampoDescrição
urlURL pública da imagem armazenada no bucket do aiqfome.
highlightedIndica se esta imagem é a principal (destaque) do item.
statusStatus atual da moderação (Ex: "imagem aguardando aprovação", "aprovada", "reprovada").
status_reasonMotivo da reprovação, caso a imagem não tenha sido aceita pelo time de qualidade (Padrão: null).

Remover Imagem

Este endpoint é utilizado para excluir permanentemente a imagem vinculada a um item de cardápio.

DELETE
/images/{store_id}/item/{uuid}

aiqfome

© Copyright 2007-2026 aiqfome LTDA .