# 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#/](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

# Descrição dos campos de entrada

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-"><tbody><tr><td>**Campo**</td><td>**PAI**</td><td>**Descrição**</td></tr><tr><td>id\_cenario</td><td>regras</td><td>Código de identificação do cenário</td></tr><tr><td>codigo\_produto</td><td>regras</td><td>Código do produto</td></tr><tr><td>origem\_produto</td><td>regras</td><td>Origem do produto</td></tr><tr><td>data</td><td>regras</td><td>Data de referência para á partir de quando a consulta será feita</td></tr></tbody></table>

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

# Descrição dos campos de retorno

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-"><tbody><tr><td>**Campo**</td><td>**PAI**</td><td>**Descrição**</td></tr><tr><td>status</td><td>/</td><td>Status de criação de regra</td></tr><tr><td>msg</td><td>/</td><td>Mensagem de retorno</td></tr><tr><td>id\_consulta</td><td>/</td><td>Identificador da consulta</td></tr></tbody></table>

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

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-c%C3%B3digo-msg-201-consu"><tbody><tr><td>**código**</td><td>**msg**</td></tr><tr><td>201</td><td>Consulta andamento da regra em processamento.</td></tr><tr><td colspan="1" rowspan="2">400</td><td>Token inválido</td></tr><tr><td>Token não enviado</td></tr><tr><td colspan="1">406</td><td>Dados incorretos, falha ao gravar consulta.</td></tr></tbody></table>

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

# Exemplo de chamada

{  
 "regras": \[  
 {  
 "id\_cenario": "1553883",  
 "codigo\_produto": "42429",  
 "origem\_produto": "0",  
 "data": "01/08/2020"  
 }  
 \]  
}

# Exemplo de retorno

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

# API de retorno

# Descrição dos campos de entrada

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-"><tbody><tr><td>**Campo**</td><td>**PAI**</td><td>**Descrição**</td></tr><tr><td>id\_consulta</td><td>/</td><td>Identificador da consulta (id do retorno da API de criação de consulta)</td></tr></tbody></table>

# Descrição dos campos de retorno

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-"><tbody><tr><td>**Campo**</td><td>**PAI**</td><td>**Descrição**</td></tr><tr><td>id\_cenario</td><td>/</td><td>Identificador do cenário</td></tr><tr><td>codigo\_produto</td><td>/</td><td>Código do produto</td></tr><tr><td>origem\_produto</td><td>/</td><td>Origem do produto</td></tr><tr><td>code</td><td>/</td><td>Código da mensagem</td></tr><tr><td>msg</td><td>/</td><td>Mensagem de status da regra</td></tr></tbody></table>

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

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-code-msg-99-regra-n%C3%A3"><tbody><tr><td>**code**</td><td>**msg**</td></tr><tr><td>99</td><td>Regra não encontrada</td></tr><tr><td>0</td><td>Consulta pendente</td></tr><tr><td>1</td><td>Regra aprovada no Cockpit intermediário</td></tr><tr><td>2</td><td>Regra represada nas queries de qualidade do Cockpit intermediário</td></tr><tr><td>3</td><td>Regra pendente de aprovação no Cockpit intermediário</td></tr><tr><td>4</td><td>Regra disponível no webservice de entrega</td></tr><tr><td>5</td><td>Regra bloqueada no webservice de entrega</td></tr><tr><td>6</td><td>Regra aprovada no relatório de processamento</td></tr><tr><td>7</td><td>Regra rejeitada no relatório de processamento</td></tr><tr><td>8</td><td>Regra no relatório de processamento</td></tr><tr><td>9</td><td>Regra enviada por carga expressa e em replicação para carga interna</td></tr><tr><td>10</td><td>Regra enviada por carga expressa e aguardando replicação carga interna</td></tr><tr><td>11</td><td>Regra enviada por carga expressa</td></tr><tr><td>12</td><td>Regra calculada</td></tr><tr><td>13</td><td>Cenário não vinculado com a base</td></tr><tr><td>14</td><td>Produto não inserido no grupo de produto do cenário</td></tr><tr><td>15</td><td>Produto não configurado</td></tr></tbody></table>

# Exemplo de chamada

{  
 "id\_consulta": "87"  
}

# 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"  
 }  
 \]  
\]