Upload de imagens
Endpoint
Método HTTP: POST
URL : /upload/{imageType}
Parâmetros de Requisição
Parâmetro | Tipo | Descrição |
---|---|---|
imageType | string required | Define o tipo de arquivo salvo. Valores aceitos: logo ou banner |
Conteúdo da Requisição
O payload da requisição deve incluir a seguinte propriedade no formato multipart/form-data
.
Propriedade | Tipo | Descrição |
---|---|---|
image | file required | Caminho do arquivo de imagem a ser enviado. O arquivo precisa estar no formato .jpeg ou .png . |
INFO
banner: Dimensões aceitas 700x1024px.
logo: Recomenda-se as proporções 1:1 (quadrada).
INFO
Imagem com tamanho até 300kb nos formatos PNG e JPEG.
Exemplo de Requisição
sh
curl --request POST \
--url https://api.minu.biz/v1/upload/logo \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'image=@"/path/images/minu-logo.png"'
Propriedades de Resposta
Se a requisição for bem-sucedida, a API retornará as seguintes propriedades no formato JSON
Propriedade | Tipo | Descrição |
---|---|---|
imageId | string | ID da imagem criada na plataforma. |
fileName | string | Nome da imagem enviada para plataforma. |
Exemplo de Resposta
sh
{
"imageId": "67e6e637f3be1fa30c7cf10b",
"fileName": "minu-logo.png"
}