Gestão de Imagens de Produtos (SKU)

Endpoints Disponíveis

• POST /v1/storages/image/upload - Upload de imagens
• GET /v1/storages/file/{externalIdentifier}/{fileType} - Consulta de imagens
• DELETE /v1/storages/integration/file/{externalIdentifier} - Exclusão de imagens

Upload de imagens

POST /v1/storages/image/upload

Header

• Authorization: Basic Auth contendo a chave publica e secreta disponibilizadas 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

Exemplo de Autorização

Para gerar o valor de Authorization, você precisa codificar suas credenciais (public_key:secret_key) em base64. Por exemplo, se sua chave pública for public_key e sua chave secreta for secret_key, você deve codificar public_key:secret_key em base64.

echo -n 'public_key:secret_key' | base64

Parametros da requisição

• externalIdentifier (string): Identificador externo do item.

Exemplo de Corpo da Requisição

Corpo da Requisição

O corpo da requisição deve ser uma lista de arquivos:

Campo	Tipo	Nullable	Descrição
files	file	Não	Imagem a ser cadastrada.

Respostas

• 200: Retorna sucesso da operação.
• 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" }

Exemplo de Resposta para Erro (400)

{
  "error": "Invalid request",
  "details": "The name field is missing in one of the product items."
}

Consulta de imagens

GET /v1/storages/file/:externalIdentifier/:entityType

Header

• Authorization: Basic Auth contendo a chave publica e secreta disponibilizadas 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

Exemplo de Autorização

Para gerar o valor de Authorization, você precisa codificar suas credenciais (public_key:secret_key) em base64. Por exemplo, se sua chave pública for public_key e sua chave secreta for secret_key, você deve codificar public_key:secret_key em base64.

echo -n 'public_key:secret_key' | base64

Parametros da requisição

• productId (string): Identificador externo do item.
• entityType (int): Tipo de entidade - sempre enviar 1 para SKU's.

Respostas

• 200: Retorna sucesso da operação.
• 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)

{ 
    [
    "https://grocerscmsstorage.blob.core.windows.net/zonasul/e9a2fca6-198f-4b4a-a183-2356ef6562f5/SKUs/01729925-d2f3-46ef-fb2f-08dcf2ebd09b/capa_seca1.jpeg",
    "https://grocerscmsstorage.blob.core.windows.net/zonasul/e9a2fca6-198f-4b4a-a183-2356ef6562f5/SKUs/01729925-d2f3-46ef-fb2f-08dcf2ebd09b/voo_alterado_1.png",
    "https://grocerscmsstorage.blob.core.windows.net/zonasul/e9a2fca6-198f-4b4a-a183-2356ef6562f5/SKUs/01729925-d2f3-46ef-fb2f-08dcf2ebd09b/voo_alterado_2.png"
]
 }

Exemplo de Resposta para Erro (400)

{
  "error": "Invalid request",
  "details": "The name field is missing in one of the sku items."
}

Exclusão de imagens

DELETE /v1/storages/file/:externalIdentifier/

Header

• Authorization: Basic Auth contendo a chave publica e secreta disponibilizadas 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

Exemplo de Autorização

Para gerar o valor de Authorization, você precisa codificar suas credenciais (public_key:secret_key) em base64. Por exemplo, se sua chave pública for public_key e sua chave secreta for secret_key, você deve codificar public_key:secret_key em base64.

echo -n 'public_key:secret_key' | base64

Parametros da requisição

• externalIdentifier (string): Identificador externo do item.

Exemplo de Corpo da Requisição

Corpo da Requisição

O corpo da requisição deve conter os seguintes campos:

Campo	Tipo	Nullable	Descrição
fileType	int	Não	Tipo de entidade (1 para SKUs).
urls	array	Sim	URLs dos arquivos.
storageIds	array	Sim	Ids dos arquivos armazenados.

Respostas

• 200: Retorna sucesso da operação.
• 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" }

Exemplo de Resposta para Erro (400)

{
  "error": "Invalid request",
  "details": "The name field is missing in one of the product items."
}