Vale a pena relembrar
Vale a pena relembrar
API
API Semelhantes
Por Rafael Sena
A API Semelhantes permite você realizar consultas dos semelhantes que foram cadastrados ou excluídos, a fim de informar um status dele. A API Semelhantes, traz esta informação detalhada, informando a quantidade de produtos semelhantes, o código do produto original, o código do produto semelhante, descrição do produto semelhante, data de criação do semelhante, e outros campos de detalhamento.
Como realizar a consulta?
- O usuário deverá realizar a autenticação no corpo da chamada com os dados fornecidos pela Systax.
- A chamada é realizada no formato JSON, a tag “mas_cod_prod” refere-se ao código do semelhante e a tag “mas_origem” trata da origem do semelhante, em ambas as tags recomendamos iniciar a sequência de requisições pelo menor código de semelhante, por exemplo, 0. A tag “retornar_excluidos” permite consultar os semelhantes ativos e excluídos, a tag “paginação”, deve ser preenchida com a quantidade de registros que desejamos retornar por requisição, limitando a uma quantidade de 100 registros por requisição, a “chave_banco” deve ser informada quando o usuário estiver associado em mais de um cliente, segue abaixo exemplo de uma chamada para consultar semelhantes ativos.
- A API vai retornar à quantidade de semelhantes cadastrados, e vai trazer o detalhamento de cada semelhante conforme exemplo abaixo.
- Caso a consulta seja feita para trazer os semelhantes excluídos, tag “retornar excluídos” deve ser preenchida com a informação “True”, assim a API vai retornar com o detalhamento dos semelhantes excluídos.
URL da documentação:
https://documentacao.systax.com.br/PublicView2/Index/e6340abcee14c2eb48e847b38/29544
A importância deste documento é demonstrar, de forma prática, como realizar a consulta aos produtos semelhantes cadastrados e excluídos da base do cliente.
Cockpit
API de Aprovação e Rejeição de Regras
Por Carlos Cornejo
A API de Aprovação e Rejeição de regras tem o objetivo de buscar regras pendentes no Cockpit, utilizando como busca os parâmetros informados na chamada, e com isso realizar a ação desejada pelo usuário (aprovar ou rejeitar as regras encontradas).
Importante: é necessário ressaltar que a API atua apenas em regras que estão pendentes. Ou seja, regras aprovadas ou rejeitadas não são impactadas.
Acessos para a API
URL: https://wscockpit.systax.com.br/api/api/regras/validar
Método: POST
Autenticação
Para utilizar a API é necessário fazer a autenticação via Bearer Token, utilizando o seguinte acesso:
URL: https://app.systax.com.br/auth/access-token
Método: GET
Na API informar o token gerado
Chamada
Como dito anteriormente a API utiliza os parâmetros informados na chamada para realizar a busca de regras pendentes com base nessas informações: São elas:
id: Não tem validação de informação indicada, deve ser retornado como indicação do item no response (campo não é obrigatório)
acao: Indica qual ação será executada pela API, sendo: (campo obrigatório)
A: Aprovar regras pendentes
R: Rejeitar regras pendentes
cenario: Aprova ou rejeita regras relacionadas ao cenário indicado (campo não é obrigatório)
natureza: Aprova ou rejeita regras relacionadas a natureza informada (campo não é obrigatório)
ufOrigem: Aprova ou rejeita regras relacionadas a UF Origem informada (campo não é obrigatório)
ufDestino: Aprova ou rejeita regras relacionadas a UF Destino informada (campo não é obrigatório)
perfilOrigem: Aprova ou rejeita regras relacionadas ao Perfil Origem informado (campo não é obrigatório)
perfilDestino: Aprova ou rejeita regras relacionadas ao Perfil Destino informado (campo não é obrigatório)
munOrigem: Aprova ou rejeita regras relacionadas ao Município de Origem informado (campo não é obrigatório)
munDestino: Aprova ou rejeita regras relacionadas ao Município de Destino informado (campo não é obrigatório)
finalidade: Aprova ou rejeita regras relacionadas a Finalidade informada (campo não é obrigatório)
codProduto: Aprova ou rejeita regras relacionadas ao Código do Produto Informado (campo não é obrigatório)
origemProduto: Aprova ou rejeita regras relacionadas a Origem do Produto informada (campo não é obrigatório)
ncm: Aprova ou rejeita regras relacionadas a ncm informada (campo não é obrigatório)
extipi: Aprova ou rejeita regras relacionadas a extipi informada (campo não é obrigatório)
ean: Aprova ou rejeita regras relacionadas ao ean informado (campo não é obrigatório)
período: Aprova ou rejeita regras dentro do período informado. É indicado no formato dd/mm/aaaa a dd/mm/aaaa (campo não é obrigatório)
Dentre todos os campos o único que é obrigatório ser preenchido é o “acao”, pois é ele que determina o que a API deverá fazer com as regras pendentes encontradas.
Importante: caso apenas o campo “acao” seja preenchido, a API irá aprovar ou rejeitar todas as regras pendentes no Cockpit, de acordo com a ação indicada. Então é sempre muito importante ficar atento se realmente a chamada será feita sem nenhum parâmetro informado.
Modelo de chamada
{
"itens": [
{
"id": 0,
"acao": "",
"cenario": "",
"natureza": "",
"ufOrigem": "",
"ufDestino": "",
"perfilOrigem": "",
"perfilDestino": "",
"munOrigem": "",
"munDestino": "",
"finalidade": "",
"codProduto": "",
"origemProduto": "",
"ncm": "",
"extipi": "",
"ean": "",
"periodo": ""
}
]
}
Dados do retorno
id: Retorna de acordo com o valor indicado na chamada
protocolo: Protocolo gerado pela API no retorno da chamada
data: Informa a data em que a ação foi executada
cod: Informa o código de retorno, que indica se ação foi executada com sucesso ou não
message: Mensagem de retorno, de acordo com o código acima
Após realizar a chamada existem 4 retornos possíveis. São eles:
|
Código |
Retorno |
|
0 |
Parâmetros incorretos |
|
1 |
Deve ser indicada "acao" |
|
2 |
Retornado com sucesso |
|
3 |
Não existem regras pendentes |
Parâmetros incorretos
Alguma informação foi preenchida de forma incorreta nos campos da chamada. Nesse caso é necessário analisar novamente todos os campos que estão sendo enviados e verificar se as informações neles estão corretas.
Deve ser indicada “acao”
Como dito anteriormente o campo “acao” é o único obrigatório no preenchimento da chamada, de forma que se ele não for enviado a API retornará com erro.
Retornado com sucesso
A API buscou e identificou todas as regras que estão pendentes de acordo com os parâmetros que foram informados e realizou a ação indicada na chamada. Sendo aprovação ou rejeição.
Não existem regras pendentes
A API não identificou nenhuma regra pendente de acordo com os parâmetros que foram informados na chamada.
Exemplo de retorno
{
"itens": [
{
"id": 0,
"protocolo": 35,
"data": "18/09/2023 16:06:14",
"cod": 2,
"message": "Retornado com sucesso"
}
]
}
Conclusão
A API de Aprovação e Rejeição de Regras serve para otimizar o processo de busca e realização da ação desejada nas regras pendentes do Cockpit.
Através dela o cliente consegue informar quais os parâmetros o sistema deve considerar para buscar regras pendentes e aprovar ou rejeitar, dependente da necessidade do cliente.