APIs de Aprovação, Rejeição e Consulta de Regras Pendentes
- Introdução
- Acesso
- Autenticação
- API de Aprovação ou Rejeição de Regras
- API Consulta de Regras Pendentes
Introdução
Essas API's tem o objetivo de aprovar ou rejeitar regras que estejam pendentes e também de consultar regras pendentes.
Acesso
Swagger e Endpoint
Comunicação: REST/JSON
Para acessar a coleção de chamadas clique aqui.
Swagger: https://wscockpit.systax.com.br/api/swagger/index.html
|
Descrição |
Grupo Swagger |
Método |
URL Endpoint |
URL Token |
|---|---|---|---|---|
|
Aprovar ou rejeitar |
Regras |
POST |
https://wscockpit.systax.com.br/ api/api/regras/validar |
|
| Consultar regras pendentes no Cockpit | Regras | POST | https://wscockpit.systax.com.br/api/ api/regras/pendentes |
https://app.systax .com.br/auth/ access-token |
Autenticação
A autenticação é feita via JWT bearer token ou Basic Auth.
Para mais informações sobre como gerar o token, acesse a documentação API - Gerar token.
API de Aprovação ou Rejeição de Regras
Estrutura dos dados da chamada
| Campo | Descrição | Obrigatório |
| id | Não tem validação de informação indicada, deve ser retornado como indicação do item no response | Não |
| acao | Indica qual ação será executada pela API. A: Aprovar regras pendentes, de acordo com os parâmetros informados. R: Rejeitar regras pendentes, de acordo com os parâmetros informados. |
Sim |
| cenario | Aprova ou rejeita regras relacionadas ao cenário indicado | Não |
| natureza | Aprova ou rejeita regras relacionadas a informação, se recebida | Não |
| ufOrigem | Aprova ou rejeita regras relacionadas a informação, se recebida | Não |
| ufDestino | Aprova ou rejeita regras relecionadas a informação, se recebida | Não |
| perfilOrigem | Aprova ou rejeita regras relacionadas a informação, se recebida | Não |
| perfilDestino | Aprova ou rejeita regras, relacionadas a informação, se recebidas | Não |
| munOrigem | Aprova ou rejeita regras, relacionadas a informação, se recebidas | Não |
| munDestino | Aprova ou rejeita regras, relacionadas a informação, se recebidas | Não |
| finalidade | Aprova ou rejeita regras, relacionadas a informação, se recebidas | Não |
| codProduto | Aprova ou rejeita regras, relacionadas a informação, se recebidas | Não |
| origemProduto | Aprova ou rejeita regras, relacionadas a informação, se recebidas | Não |
| ncm | Aprova ou rejeita regras, relacionadas a informação, se recebidas | Não |
| extipi | Aprova ou rejeita regras, relacionadas a informação, se recebidas | Não |
| ean | Aprova ou rejeita regras, relacionadas a informação se recebidas | Não |
| periodo | É indicado no formato dd/mm/aaaa a dd/mm/aaaa e a API aprova ou rejeita regras pendentes dentro desse |
Importante: Caso não seja informado o campo ação, a API irá retornar uma mensagem de erro "o campo acao deve ser indicado".
Importante 2: Se não informado nenhum parâmetro, todas as regras pendentes serão aprovadas ou rejeitadas, de acordo com a ação indicada.
Códigos de retorno
| Código | Retorno |
| 0 | Parâmetros incorretos |
| 1 | Deve ser indicada "acao" |
| 2 | Retornado com sucesso |
| 3 | Não existem regras pendentes |
Estrutura dos dados de retorno
| Campo | Descrição |
| id | Retorna de acordo com o valor indicado na chamada |
| protocolo | Protocolo gerado 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 |
Exemplo de chamada
{
"itens": [
{
"id": 0,
"acao": "A",
"cenario": "2104488",
"natureza": "108",
"ufOrigem": "GO",
"ufDestino": "SP",
"perfilOrigem": "2",
"perfilDestino": "578",
"munOrigem": "",
"munDestino": "",
"finalidade": "175",
"codProduto": "630797",
"origemProduto": "0",
"ncm": "01012100",
"extipi": "",
"ean": "10203040",
"periodo": ""
}
]
}
Exemplo de retorno
{
"itens": [
{
"id": 0,
"protocolo": 35,
"data": "18/09/2023 16:06:14",
"cod": 2,
"message": "Retornado com sucesso"
}
]
}
API Consulta de Regras Pendentes
Estrutura dos dados da chamada
| Campo | Descrição | Obrigatório |
| Id | Não tem validação de informação indicada, deve ser retornado como indicação do item no response | Não |
| cenario | Se indicado busca regras pendentes relacionadas ao cenários indicado | Não |
| natureza | Se indicado busca regras pendentes com essa informação | Não |
| ufOrigem | Se indicado busca regras pendentes com essa informação | Não |
| ufDestino | Se indicado busca regras pendentes com essa informação | Não |
| perfilOrigem | Se indicado busca regras pendentes com essa informação | Não |
| perfilDestino | Se indicado busca regras pendentes com essa informação | Não |
| munOrigem | Se indicado busca regras pendentes com essa informação | Não |
| munDestino | Se indicado busca regras pendentes com essa informação | Não |
| finalidade | Se indicado busca regras pendentes com essa infromação | Não |
| codProduto | Se indicado busca regras pendentes com essa informação | Não |
| origemProduto | Se indicado busca regras pendentes com essa informação | Não |
| ncm | Se indicado busca regras pendentes com essa informação | Não |
| extipi | Se indicado busca regras pendentes com essa informação | Não |
| ean | Se indicado busca regras pendentes com essa informação | Não |
| data | É indicado no formato dd/mm/aaaa a dd/mm/aaaa e a API busca as regras pendentes dentro desse período | Não |
Importante: as regras pendentes serão informadas pela API, de acordo com os parâmetros preenchidos na chamada. Caso nenhum parâmetro seja informado, todas as regras pendentes de aprovação retornarão na API.
Códigos de retorno
| Código | Retorno |
| 0 | Parâmetros incorretos |
| 1 | Retornado com sucesso |
| 2 | Não existem regras pendentes |
Estrutura dos dados de retorno
O retorno da API será com todos os dados do Cockpit, seguindo todos os detalhes da regra que está pendente de aprovação.
Exemplo de chamada
{
"id": 0,
"cenario": "2336815",
"natureza": "121",
"ufOrigem": "",
"ufDestino": "",
"perfilOrigem": "3",
"perfilDestino": "6",
"munOrigem": "",
"munDestino": "",
"finalidade": "",
"codProduto": "",
"origemProduto": "",
"ncm": "",
"extipi": "",
"ean": "",
"data": ""
}
Exemplo de retorno
{
"cenario": [
{
"ent_sai": "3",
"id_cenario": "2336815",
"apelido": "Revenda-MG-SP-Varejo-CFNC",
"dias_futuros": "30",
"uf_origem": "MG",
"uf_destino": "SP",
"origem": "3",
"destinacao": "6",
"cod_natureza_operacao": "121",
"retorno": [
{
"cod_prod": "NCM00000000-0",
"descricao": "Frete",
"ean": "8880001040289",
"ncm": "00000000",
"origem_produto": "0",
"cfop": "6357",
"icms": {
"cst": "00",
"bc_composicao": 2,
"bc_composicao_sn_especial": 0,
"bc_composicao_fcp": 0,
"aliquota": "12.0000",
"generico": "tributos_aproximados_Estadual=18.00|tributos_aproximados_Federal=7.85|pendente_revisao=1|indice_precisao=0",
"vigencia_de": "2023-07-01T00:00:00",
"dispositivo_legal": "Art. 12, I do RICMS/MG. Art. 11, II e item 3.1 do Anexo I, Parte II do RICMS/MG",
"icms_uf_dest": {
"cst": "00",
"bc_composicao": 2,
"bc_composicao_fcp": 0,
"aliq_interna_dest": "12.0000",
"perc_partilha_dest": "100.0000",
"vigencia_de": "2019-01-01T00:00:00",
"dispositivo_legal": "art. 37, I, e § 1º do RICMS/SP, art. 54, I do RICMS/SP"
},
"estatistica": "A05|A06|A07"
},
"pis": {
"cst": "01",
"bc_composicao": 2,
"aliquota": "0.65",
"vigencia_de": "2002-12-01T00:00:00",
"dispositivo_legal": "Art. 8º, I, da Lei nº 9.715/1998."
},
"cofins": {
"cst": "01",
"bc_composicao": 2,
"aliquota": "3.00",
"vigencia_de": "2004-02-01T00:00:00",
"dispositivo_legal": "Art. 8º da Lei nº 9.718/1998."
}
}
]
}
],
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}