Pular para o conteúdo principal

Upload de Imagens de Produtos via SFTP

Este guia descreve como você pode utilizar as credenciais fornecidas para se conectar a um servidor SFTP, enviar múltiplos arquivos (imagens) e, em seguida, chamar um endpoint que recebe um array de produtos com caminhos de imagens atualizados para atualização da imagem do SKU.

Passo 1: Conexão com o Servidor SFTP​

Credenciais e Protocolo​

  • Protocolo: SFTP
  • Host: sftp.seudominio.com
  • Port: 22
  • Username: seu-usuario
  • Password: sua-senha

Observação: Substitua sftp.seudominio.com, seu-usuario e sua-senha com os valores recebidos nas credenciais de acesso.

Como Conectar​

  1. Utilize um cliente SFTP de sua preferência (por exemplo, FileZilla ou WinSCP) para estabelecer a conexão.
  2. Configure o cliente com as informações acima.
  3. Após autenticação bem-sucedida, você poderá navegar pelos diretórios do servidor.

Estrutura de Diretórios​

Para acessar a pasta que corresponde a integração de imagens de SKUs, siga o caminho abaixo:

  • Acesse a pasta "zonasul"
  • Acesse a pasta que contém o seu "contractAccountId" no nome (normalmente só uma pasta estará disponível)
  • Acesse a pasta "SKUs"
  • Acesse a pasta "Integracao"

Exemplo de SFTP

Passo 2: Upload de Múltiplos Arquivos​

  1. Dentro do cliente SFTP, selecione os arquivos de imagem na sua máquina local.
  2. Arraste e solte (ou selecione manualmente) esses arquivos para o diretório de destino no servidor (nesse caso, /zonasul/<contractAccountId>/SKUs/Integracao).
  3. Aguarde até que todos os arquivos sejam transferidos com sucesso.

Dica: Antes do envio, renomeie os arquivos de forma padronizada para facilitar a organização e futura referência (por exemplo, produto-123-frente.png, produto-123-verso.png etc.).

Passo 3: Chamada ao Endpoint de Registro/Atualização de Imagens​

Após o upload bem-sucedido, você precisará informar ao seu sistema (via API) quais produtos receberam quais imagens.

POST /v1/products/images​

Objetivo: Atualizar os produtos com as imagens que foram enviadas via SFTP.

Headers​

  • Authorization: Basic Auth contendo a chave pública e a chave secreta fornecidas para o cliente.
    • Exemplo: Basic <base64-encoded-credentials>
  • x-contractAccountId: Identificador da conta do contrato do cliente.
    • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82
  • Content-Type: application/json

Corpo da Requisição​

Envie um array de objetos, cada objeto representando uma relação entre o SKU e o caminho da imagem no servidor SFTP.
Cada objeto deve conter:

  • skuExternalReference: Identificador único do SKU.
  • imagePath: Caminho completo da imagem no servidor SFTP.

Exemplo de Corpo da Requisição​

[
  {
    "skuExternalReference": "1",
    "imagePath": "/zonasul/<contractAccountId>/SKUs/Integracao/produto-001.png"
  },
  {
    "skuExternalReference": "2",
    "imagePath": "/zonasul/<contractAccountId>/SKUs/Integracao/produto-002.jpg"
  }
]

Respostas​

  • 200: Retorna sucesso da operação. A resposta incluirá detalhes sobre o processamento da lista de produtos.
  • 400: Retorna erro de requisição inválida. Isso geralmente ocorre devido a dados de entrada mal formatados ou faltando.
  • 500: Retorna erro interno do servidor. Indica problemas no processamento da requisição no servidor.

Exemplo de Resposta para Sucesso (200)​

{ "operationId": "402fe685-2060-432b-ac57-223eb2e680f3" }