Associação e desassociação de grupo de produtos em um cenário

Por Paulo Campos

Endereço Web: Swagger UI

Conforme processo de melhoria contínua de integração, foi criada uma API que possibilita aos nossos clientes e parceiros associar e retirar a associação de grupo de produtos em cenários específicos. Esta API visa dar mais opções e controle, uma vez que promove a possiblidade de associar grupo de produtos em cenários já existentes, sendo também possível retirar a associação efetuada anteriormente (desassociar).

Nesse artigo, vamos demonstrar o processo para efetuar essas modificações, utilizando nosso Swagger, selecionado o endpoint “cenários_grupos_assoc”:

Ao selecionar a API em questão, o usuário primeiramente deverá selecionar o meio de autenticação (destaque em vermelho na imagem acima), na forma de inserção de Usuário/ Senha ou por meio de Bearer Token:

Ao selecionar o botão “Authorize”, o usuário já vai poder efetuar as chamadas necessárias para processamento.

Ao selecionar a opção “Try Out”, encontrada na faixa branca superior ao lado de “Parameters”, a opção “Request Body”, que antes encontrava-se na cor preta, ficará branca, sendo possível editar o body demonstrado para então efetuar a chamada de acordo com o grupo e cenário desejado.

O Body apresenta os seguintes campos necessários para que o usuário preencha e assim efetue as devidas alterações necessárias:

• Ação: Seleciona a ação que o usuário direciona para a API, devendo ser preenchido com as palavras “associar” caso o usuário queira inserir um grupo num determinado cenário, caso contrário, utilizar a palavra “desassociar”;
• Id_cenario: Número do ID cenário do cliente encontrado no banco de dados Systax;
• Nome_grupo: Nome do grupo que será associado ou desassociado de um cenário.

É possível utilizar uma mesma chamada para associar e desassociar grupos e cenários distintos. Abaixo um exemplo de uma chamada com demonstração de seus efeitos.

Os nomes dos grupos ou IDs dos cenários selecionados podem ser consultados por um usuário Systax, diretamente no Admin ERP Configurações ou pelo próprio site da Systax. Já os clientes e parceiros poderão realizar essas mesmas consultas utilizando outras APIs. Vejamos abaixo o exemplo dos efeitos na tela do Admin Systax:

Na imagem acima, é possível observar cada cenário cujo grupo foi associado e, no primeiro exemplo, o grupo “PenTest” foi associado no cenário ID 2448871. Já no segundo exemplo, o grupo PenTest foi desassociado do cenário ID 2518440, portanto é possível notar a ausência do nome de um grupo na coluna correspondente.

Esta API tem como objetivo dar uma maior abertura aos nossos clientes/ parceiros e poder de modificação no agrupamento de produtos com os cenários relevantes a sua operação, visando uma maior eficiência na geração de informações e busca de dados.

Association and Disassociation of a products group in a scenario

By Paulo Campos

Web Address: Swagger UI

As the process of continuous improvement of integration, we created an API that enable our customers to associate and disassociate a group of products in specific scenarios. This API give more options and control over the rules of the clients that exists in our data base, giving they a more open way to determine which groups belongs to which rule scenario.

IN this article we will demonstrate how to modify groups to a different scenario, using our Swagger and selecting the endpoint “cenários_grupos_assoc”:

When the API is selected, firstly the user will have to choose the authentication method (marked in red on the image above), using Login/ Password or Bearer token:

After the user selects the button “Authorize,” he already can do the necessary requests.

Selecting “Try Out”, which can be found on the superior white box, at the side of “Parameters”, the option “Request Body”, that was on the color black, will become white, so it can be possible to edit the body informing the necessary data to begin the modifications intended.

The body presents the following fields to be filled, that way the integrations can be done, with direct effect over the group intended:

• Ação: Selecting “Associar,” the API will recognize the scenario and group selected and associate them. Selecting “Desassociar,” the API will remove the association did before.
• Id_cenario: Number of the ID of the scenario.
• Nome_grupo: Name of the group of products that can be associate or disassociate.

It is possible to use, in the same request, the association and disassociation of distinct groups and scenarios. Below it is an example of a request with the effects on other Systax tools:

Every name or ID selected can be consulted directly in Systax Admin (ERP Configurações), or even in the Systax web site, and our clients and partners can use other APIs to consult the information necessary. We can see below an example of this effect in Systax Admin:

As showed above, we can see every scenario with a group associated and, in the first example, the group “PenTest” was associated to the scenario ID 2448871. In the second example, the group “PenTest” was disassociated from the scenario ID 2518440, so it is noted the absence of the group name in the related column.

This API has the objective to give more opening to our clients to modify a group of products in the relevant scenarios or tax rules in your operation. In return, they will have a bigger efficiency in the generation of information and data consulting.

Voltar