Acompanhamento de regras


Introdução

Essa API tem por objetivo informar o status completo de uma regra, seja quando criada ou alterada. Ela apresenta todo o percurso de criação/alteração da regra e é consultada de forma individual ou em lote.

Acesso

Swagger: https://app.systax.com.br/auth/swagger#/

 

API Rest/JSON de criação de consulta:

Método: POST

URL: http://app.systax.com.br/acompanhamento_regra

 

API Rest/JSON de retorno:

Método: GET

URL: http://app.systax.com.br/acompanhamento_regra

Autenticação

A autenticação pode ser feita pelo método Basic Auth ou JWT bearer token.

Para mais informações sobre o token:

API - Gerar token

Também é necessário que o serviço dessa API esteja ativo no Site Systax.

API Criação de consulta

API Criação de consulta

Descrição dos campos de entrada

Campo PAI Descrição
id_cenario regras Código de identificação do cenário
codigo_produto regras Código do produto
origem_produto regras Origem do produto
data regras Data de referência para á partir de quando a consulta será feita

 

Obsevação: A API suporta até 100 regras por requisição.

API Criação de consulta

Descrição dos campos de retorno

Campo PAI Descrição
status / Status de criação de regra
msg / Mensagem de retorno
id_consulta / Identificador da consulta

 

Tabela de referência para o campo "msg":

código msg
201 Consulta andamento da regra em processamento.
400 Token inválido
Token não enviado
406 Dados incorretos, falha ao gravar consulta.

 

Observação: O identifcador da consulta deve ser armazenado para possibilitar o retorno da consulta. 

API Criação de consulta

Exemplo de chamada

{
  "regras": [
    {
      "id_cenario": "1553883",
      "codigo_produto": "42429",
      "origem_produto": "0",
      "data": "01/08/2020"
    }
  ]
}

API Criação de consulta

Exemplo de retorno

{
  "status": "ok",
  "msg": "Consulta andamento da regra em processamento.",
  "id_consulta": "81"
}

API de retorno

API de retorno

Descrição dos campos de entrada

Campo PAI Descrição
id_consulta / Identificador da consulta (id do retorno da API de criação de consulta)
API de retorno

Descrição dos campos de retorno

Campo PAI Descrição
id_cenario / Identificador do cenário
codigo_produto / Código do produto
origem_produto / Origem do produto
code / Código da mensagem
msg / Mensagem de status da regra

 

Tabela de referência para os campos "code" e "msg":

code msg
99 Regra não encontrada
0 Consulta pendente
1 Regra aprovada no Cockpit intermediário
2 Regra represada nas queries de qualidade do Cockpit intermediário
3 Regra pendente de aprovação no Cockpit intermediário
4 Regra disponível no webservice de entrega
5 Regra bloqueada no webservice de entrega
6 Regra aprovada no relatório de processamento
7 Regra rejeitada no relatório de processamento
8 Regra no relatório de processamento
9 Regra enviada por carga expressa e em replicação para carga interna
10 Regra enviada por carga expressa e aguardando replicação carga interna
11 Regra enviada por carga expressa
12 Regra calculada
13 Cenário não vinculado com a base
14 Produto não inserido no grupo de produto do cenário
15 Produto não configurado
API de retorno

Exemplo de chamada

{
  "id_consulta": "87"
}

API de retorno

Exemplo de retorno

[
  [
    {
      "id_config": "1553883",
      "codigo_produto": "42429",
      "origem_produto": "0",
      "code": "1",
      "msg": "Regra aprovada no Cockpit intermediário"
    },
    {
      "id_config": "1553884",
      "codigo_produto": "42429",
      "origem_produto": "0",
      "code": "11",
      "msg": "Cenário não vinculado com a base"
    }
  ]
]