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).

Com a nova funcionalidade que implementamos na API, agora também é possível aprovar regras rejeitadas e rejeitar regras aprovadas.

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 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 ou rejeitadas

            R: Rejeitar regras pendentes ou aprovadas

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 encontradas.

Importante: caso apenas o campo “acao” seja preenchido, a API irá aprovar ou rejeitar todas as regras 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:
 

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, 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 com os parâmetros informados

A API não identificou nenhuma regra, 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 do Cockpit.

Através dela o cliente consegue informar quais os parâmetros o sistema deve considerar para buscar regras e aprovar ou rejeitar, dependendo da necessidade do cliente.

Voltar