Cockpit – API de regras – Novo campo da API “grupo_produto associado”
API de regras – Novo campo da API “grupo_produto associado”
Por Fernanda Almeida
O Cockpit possui algumas API's que permitem a integração do cliente/parceiro com algumas de suas funcionalidades. Temos por exemplo: a API de leitura de regras.
A documentação da API pode ser consultada através do manual no link: https://documentacao.systax.com.br/PublicView2/Index/9c4526c422d012721f5a35efc/25976
Para atender a necessidade dos clientes, fizemos uma alteração na API de regras em que incluímos o campo “grupo_produto_associado”.
Esse campo retorna o grupo de produtos o qual o produto da chamada está associado, dando visibilidade ao cliente e ou usuário no retorno da regra.
A chamada da API e o retorno são os seguintes é feita da seguinte forma:
No retorno da regra, trazemos 2 campos:
- Grupo_produtos = todos os grupos de produtos que são associados ao cenário
- Grupo_produto_associado = grupo o qual o produto faz parte
Consulta do cenário no cockpit:
Consulta da associação do produto no grupo:
Conclusão: A inclusão do novo campo da API dá transparência ao retorno da regra e informa ao usuário todas as informações quanto ao cenário e o produto.
Rules API – New API field "associated_product_group"
By Fernanda Almeida
The Cockpit has some APIs that allow the integration of the client/partner with some of its functionalities. We have, for example, the rules reading API.
The API documentation can be consulted through the manual at the link: https://documentacao.systax.com.br/PublicView2/Index/9c4526c422d012721f5a35efc/25976
To meet the needs of our clients, we made a change to the rules API in which we included the field "grupo_produto_associado".
This field returns the product group to which the product in the call is associated, providing visibility to the customer and/or user in the rule's response.
The API call and the return are as follows and are made in the following way:
In the return of the rule, we bring 2 fields:
- Product_groups = all the product groups that are associated with the scenario
- Grupo_produto_associado = group to which the product belongs
Consultation of the scenario in the cockpit:
Consultation of the product association in the group:
Conclusion: The inclusion of the new API field provides transparency to the rule's return and informs the user of all the information regarding the scenario and the product.