Este artigo apresenta as etapas para carregar e baixar produtos usando a API Scantrust. Primeiro, você precisará de um token UAT com as seguintes permissões:
- criação_de_produto
- excluir produto
- edição_do_produto
- visão do produto
Você também precisará de pelo menos uma marca configurada no Portal: cada produto criado deve ser atribuído a uma marca.
Importante:
Para acessar a API REST do Scantrust, você pode usar uma plataforma de API como o Postman, a plataforma de API mais popular do mundo, com mais de 17 milhões de usuários e 500.000 organizações em todo o mundo. A ferramenta oferece um ambiente flexível e colaborativo que permite projetar, desenvolver, documentar e testar suas APIs com mais rapidez.
Você pode experimentar o aplicativo da web ou baixar e instalar este aplicativo neste link: https://www.postman.com/downloads/ Em qualquer caso, você deve se registrar com um endereço de e-mail válido.
Observação: No contexto do Scantrust, o Postman deve ser usado apenas para fins de teste. Não deve ser usado em cenários reais ou implementações de projetos.
Etapas para configurar o Postman:
1. Abra o Postman. Na página inicial, você verá o seguinte:
2. Em seguida, clique na aba "Espaços de trabalho" no canto superior esquerdo:
3. Em seguida, clique na opção “Meu Espaço de Trabalho”:
4. Quando estiver no seu espaço de trabalho, clique no sinal “+” da seguinte maneira:
5. Após isso, uma nova aba aparecerá com uma requisição de API pré-configurada: GET:
6. Agora é importante configurar a Autorização da API. Para isso, clique na aba "Autorização":
7. Em seguida, clique na seção "Tipo" e selecione a opção "Chave de API", conforme a seguir:
8. Agora, digite a palavra "Autorização" no campo de chave, copie seu token UAT do portal ST e cole-o no campo "Valor", incluindo os caracteres UAT.UAT [token tu], deixando uma barra de espaço entre a string UAT e o token:
9. Em seguida, vá até a aba “Body”, selecione “raw” e selecione “JSON”:
Etapas para fazer upload de produtos com a API Scantrust
1. Neste ponto, você está pronto para enviar um produto usando a API do Scantrust. Para o primeiro passo, você precisará alterar a solicitação da API para POST. Clique no botão de solicitação e selecione a opção "POST".
2. Para configurar esta solicitação, você precisará inserir a URL, que neste caso é a seguinte: https://api.scantrust.com/api/v2/products/:
3. Em seguida, na aba corpo, digite o seguinte:
{
"sku": "PR3",
"marca": 2841,
"nome": "Produto três",
"description": "O terceiro produto de uma linha de muitos outros.",
"client_url": "http://www.examplebrand.com/productone",
"campaña": 575
}
Onde SKU se refere ao SKU exclusivo do produto na empresa, marca se refere ao ID da marca (inteiro) ou referência (string) e nome se refere ao nome do produto. Todos esses sãocampos obrigatóriospara estabelecer a solicitação.
Por outro lado, o campo de descrição refere-se a uma breve descrição do produto; a URL do cliente refere-se à URL do produto, que pode ser usada para redirecionar códigos caso não haja uma campanha ativa para o produto; e o campo de imagem permite incluir uma imagem do produto, normalmente usada em landing pages STC. Se não for definida, serão utilizadas a imagem da marca e a imagem da campanha, que é o ID de uma campanha existente na empresa à qual este produto deve ser adicionado. Todos esses campos são opcionais.
4. Depois de terminar o script do código, podemos clicar no botão ENVIAR:
5. Quando um produto é publicado com sucesso, a resposta fica assim:
Se o upload for bem-sucedido, a resposta de status deverá ser 200 ou 201. Você poderá então verificar a criação deste novo produto no portal Scantrust.
Etapas para baixar produtos com a API Scantrust
Você precisará de um token UAT com as seguintes permissões:
- product_view
Nesse caso, recuperaremos informações do produto para uma empresa inteira ou um produto específico usando apenas o SKU do produto.
1. Acesse o seu espaço de trabalho do Postman e abra uma nova aba com o sinal “+”:
2. Em seguida, vá até a aba “Corpo” e selecione “nenhum”:
3. Para baixar informações do produto, você precisará configurar uma solicitação GET inserindo a URL, que neste caso é a seguinte: https://api.scantrust.com/api/v2/products/:
4. Em seguida, clique no botão ENVIAR:
5. Quando a solicitação da API for bem-sucedida, a resposta de status deverá ser 200 e a resposta será fornecida:
Esta resposta inclui todos os produtos listados na sua empresa, com atributos específicos, como SKU, nome, descrição, marca e muito mais.
6. Caso queira saber informações específicas do produto, precisamos configurar a requisição GET informando a URL, que neste caso é a seguinte: https://api.scantrust.com/api/v2/products/?sku_exact=[SKU]:
Nesse caso, a resposta inclui apenas as informações do produto para o ID especificado no URL.
Comentários