Foto

A API Dezwork permite o cadastro de fotos nos produtos tanto por link quanto por uploaded file. No caso de link, as requisições podem ser feitas utilizando application/json e em caso de arquivo, deverá ser multipart/form-data, caso contrário, o arquivo não será salvo corretamente.

A Dezwork trata as fotos dos produtos em 3 tamanhos (P, M e G). Em caso de cadastro por link, os links dos 3 tamanhos deverão ser informados. Caso contrário, o arquivo deverá ser enviado apenas em um tamanho (G), e a API irá realizar os redimensionamentos necessários para salvá-la nos 3 tamanhos. O tamanho das fotos em pixels pode variar conforme a template da loja.

Para simular o envio de arquivos, confira a o tutorial “Simulando envio de arquivos no POSTMAN” da sessão de testes da documentação.

Adicionar Foto

Referência

POST https://api.dezwork.com/v1/produtos/imagens

Parâmetros	Tipo	Descrição
fileP*¹	string	URL da foto tamanho P
fileM*¹	string	URL da foto tamanho M
fileG*	string	URL da foto tamanho G ou arquivo uploaded file
active	boolean	Foto ativa?
orderNumber	int	Nº da ordenação da foto

¹Obrigatórios apenas no envio da foto por URL

Nota

Parâmetros com asterisco ( * ) são obrigatórios

Exemplo de Requisição

JSON

{
    "fileP": "http://url.da.imagem.p",
    "fileM": "http://url.da.imagem.m",
    "fileG": "http://url.da.imagem.g",
    "active": true,
    "orderNumber": 1
}

FORM-DATA

Parâmetro	Valor
fileG*	source of local uploaded file. Ex: upload do arquivo ‘C:\fotos\imagem.png’
active	1
orderNumber	1

Resposta

Status 201: CREATED

{
    "success": true,
    "data": {
        "id": 1,
        "fileP": "http://url.da.imagem.p",
        "fileM": "http://url.da.imagem.m",
        "fileG": "http://url.da.imagem.g",
        "active": true,
        "orderNumber": 1
    }
}

Status 400: Bad Request

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Atualizar Foto

Referência

POST https://api.dezwork.com/v1/produtos/imagens

A atualização de fotos, diferente dos outros itens, é feita por POST, pois o método PUT não aceita o envio de arquivos na requisição multipart/form-data.

Nota

Parâmetros com asterisco ( * ) são obrigatórios

Exemplo de Requisição

JSON

{
    "fileP": "http://url.da.imagem.p",
    "fileM": "http://url.da.imagem.m",
    "fileG": "http://url.da.imagem.g",
    "active": true,
    "orderNumber": 1
}

FORM-DATA

Parâmetro	Valor
id*	1
fileG	source of local uploaded file. Ex: upload do arquivo ‘C:\fotos\imagem.png’
active	1
orderNumber	1

Resposta

Status 200: OK

{
    "success": true,
    "data": {
        "id": 1,
        "fileP": "http://url.da.imagem.p",
        "fileM": "http://url.da.imagem.m",
        "fileG": "http://url.da.imagem.g",
        "active": true,
        "orderNumber": 1
    }
}

Status 400: Bad Request

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Consultar Fotos

Referência

GET https://api.dezwork.com/v1/produtos/{id}/imagens

Basta uma requisição GET simples para esse endpoint, informando o ID do produto na URL para retornar todas as fotos do produto em questão.

Resposta

Status 200: OK

{
    "success": true,
    "data": [
        {
            "id": 1,
            "fileP": "http://url.da.imagem.p",
            "fileM": "http://url.da.imagem.m",
            "fileG": "http://url.da.imagem.g",
            "active": true,
            "orderNumber": 1
        },
        {
            "id": 2,
            "fileP": "http://url.da.imagem2.p",
            "fileM": "http://url.da.imagem2.m",
            "fileG": "http://url.da.imagem2.g",
            "active": true,
            "orderNumber": 1
        }
    ]
}

Status 400: Bad Request

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Consultar Foto por ID

Referência

GET https://api.dezwork.com/v1/produtos/imagens/{id}

Basta uma requisição GET simples para esse endpoint, informando o ID da foto na URL para retornar a foto em questão.

Resposta

Status 200: OK

{
    "success": true,
    "data": {
        "id": 1,
        "fileP": "http://url.da.imagem.p",
        "fileM": "http://url.da.imagem.m",
        "fileG": "http://url.da.imagem.g",
        "active": true,
        "orderNumber": 1
    }
}

Status 400: Bad Request

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Excluir Foto

Referência

DELETE https://api.dezwork.com/v1/produtos/imagens/{id}

Basta uma requisição DELETE simples para esse endpoint, informando o ID da foto na URL para excluir a foto em questão.

Resposta

Status 200: OK

{
    "success": true,
    "data": {
        "id": 1,
        "fileP": "http://url.da.imagem.p",
        "fileM": "http://url.da.imagem.m",
        "fileG": "http://url.da.imagem.g",
        "active": true,
        "orderNumber": 1
    }
}

Status 400: Bad Request

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}