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.
/images/{store_id}/item/{uuid}Parâmetros da URL
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
store_id | ✅ | ID da loja proprietária do item. |
uuid | ✅ | Identificador único (UUID) do item que receberá a imagem. |
Parâmetros do Corpo (Body - Multipart/Form-Data)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
image | file | ✅ | Arquivo de imagem (deve ser um formato de imagem válido). |
highlighted | boolean | ❌ | Define 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.
/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.
| Campo | Descrição |
|---|---|
url | URL pública da imagem armazenada no bucket do aiqfome. |
highlighted | Indica se esta imagem é a principal (destaque) do item. |
status | Status atual da moderação (Ex: "imagem aguardando aprovação", "aprovada", "reprovada"). |
status_reason | Motivo 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.
/images/{store_id}/item/{uuid}