Manual de cadastro de Produtos e Cenários RT (CFM)

• Introdução
• Acesso
• Autenticação
• Consulta de produtos
• Descrição dos campos de retorno
• Exemplo de chamada e retorno
• Cadastro de produtos
• Descritivo dos campos da chamada
• Descritivo dos campos do retorno
• Exemplos de chamada e retorno
• Consulta de cenários RT
• Descrição dos campos de retorno
• Exemplo de retorno
• Cadastro de cenários RT
• Descrição dos campos da chamada
• Descrição dos campos de retorno
• Exemplo de chamada e retorno
• Consulta grupos de produtos
• Descrição dos campos de retorno
• Exemplos de chamada e retorno
• Associação de produtos e grupos
• Conceito
• Descrição dos campos da chamada
• Descrição dos campos de retorno
• Exemplos de chamada e retorno
• Desassociação de produtos e grupos
• Descrição dos campos da chamada
• Descrição dos campos de retorno
• Exemplos de chamada e retorno
• Associação/ Desassociação de grupos nos cenários RT
• Descrição dos campos da chamada e retorno
• Exemplos de chamada e retorno
• Exclusão de produtos
• Tabela de Códigos
• Exemplos de chamada e retorno
• Exclusão de cenários RT
• Descrição dos campos de retorno
• Exemplos de chamada e retorno

Introdução

Este documento tem por objetivo orientar o time técnico de desenvolvimento dos nossos clientes e parceiros para automatizar os cadastros necessários à geração de regras tributárias da reforma tributária, que deverão ser monitoradas pela Systax. Assim, as API´s mencionadas nesse documento destinam-se a:

1. Cadastrar, consultar e deletar produtos;
2. Associar ou desassociar produtos a grupos de produtos (incluir um produto na lista de regras que serão geradas para determinado cenário) e consultar os grupos já existentes;
3. Cadastrar, consultar e deletar cenários (operações);
4. Associar ou desassociar grupos de produtos em cenários da Reforma Tributária

Esses cadastros, realizados via integração ou não, são necessários para o uso da nossa solução de Parametrização Fiscal.

Atenção: Todas as API's que estiverem com a marcação "RT" devem ser utilizadas somente para clientes que optarem exclusivamente pela geração de regras da Reforma Tributária. Portanto, para clientes que já utilizam nossas API's com a tributação atual, será feito um De-Para dos cenários para o formato RT. 

Acesso

Comunicação: REST/JSON

Swagger Cadastros para geração de regras
https://app.systax.com.br/geracao-regras-rt/swagger

Listagem dos Endpoints que contemplam o manual de Cadastros para geração das regras

Descrição	Versão	Grupo Swagger	Método	URL Endpoint
Consulta lista de produtos	v2	Produtos v2	GET	https://app.systax.com.br/v2/cfm/products
Cadastro de produtos	v2	Produtos v2	POST	https://app.systax.com.br/v2/cfm/products/multi
Consulta de cenários RT	-	Cenarios	GET	https://app.systax.com.br/cadastro-geral/rt/cenarios
Cadastro de cenários RT	-	Cenarios	POST	https://app.systax.com.br/rt/cenarios
Consulta de grupos de produtos	-	Consulta de grupos de produtos	GET	https://app.systax.com.br/cadastro-geral/groups
Associação de produtos/grupos	-	Associação de produtos ao grupo	POST	https://app.systax.com.br/cadastro-geral/assoc/products-groups
Dessociação de produtos/grupos	-	Desassociação de produtos ao grupo	POST	https://app.systax.com.br/cadastro-geral/desassociar/products-groups
Excluir produto	-	Produtos v2	DEL	https://app.systax.com.br/v2/cfm/products/
Exclusão cenários RT	v2	Cenários	DEL	https://app.systax.com.br/rt/cenarios/{}
Associação/ Desassociação de grupos nos cenários RT	-	Cenários Grupos Assoc.	POST	https://app.systax.com.br/rt/cenarios-rt/grupos/operations-assoc

Autenticação

A autenticação das API's de cadastro de produtos e cenários é feita via bearer token. Para mais detalhes de como obtê-la, acesse a última versão de documentação pelo link: 

https://documentacao.systax.com.br/books/manual-da-api-de-geracao-de-token

Consulta de produtos

Descrição dos campos de retorno

Campo	PAI	Descrição
id	produtos	ID do produto (Systax)
cod_interno	produtos	ID do produto (Cliente)
origem_produto	produtos	Origem do produto
ean	produtos	EAN do produto
descricao	produtos	Descrição do produto
descricao_sugerida	produtos	Descrição sugerida do produto pela Systax
complemento	produtos	Complemento do produto
ncm_original	produtos	NCM original do produto
ex_tipi_original	produtos	Ex TIPI original do produto
ncm_sugerida	produtos	NCM do produto sugerida pela Systax
ex_tipi_sugerida	produtos	Ex TIPI do produto sugerida pela Systax
ncm_definitiva	produtos	NCM definitiva
ex_tipi_definitiva	produtos	Ex TIPI definitiva do produto
status_atual	produtos	Status do produto
duvida_tecnica	produtos	Dúvida Técnica
resposta_tecnica	produtos	Resposta Técnica
fundamentacao	produtos	Fundamento técnico
dt_classificacao	produtos	Data de classificação do produto
data_criacao	produtos	Data de criação do produto
username_criacao	produtos	Usuário responsável pela criação do produto
total_registros	paginacao	Total de registros retornados
num_paginas	paginacao	Total de páginas
por_pagina	paginacao	Quantidade de itens por página
pagina_atual	paginacao	Página atual
itens_da_pagina	paginacao	Quantidade de itens por página
success	/	Status do retorno
message	/	Mensgem do retorno

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

Para obter a tabela completa do campo mencionado acima,  acesse o link: https://documentacao.systax.com.br/books/tabelas-auxiliares/page/origem-do-material

Tabela de referência para os campos "success" e "message":

Código de retorno	success	message
200	true	OK
	false	not_found
400	false false	token_invalid token_expired
500	false	internal_error

Exemplo de chamada e retorno

Chamada

Retorno

{
  "produtos": [
    {
      "id": "2002272",
      "cod_interno": "10026",
      "origem_produto": "0",
      "ean": "7891024194102",
      "descricao": "DESINF PINHO SOL 500ML ORIGINAL",
      "descricao_sugerida": "",
      "complemento": "",
      "ncm_original": "96032900",
      "ex_tipi_original": "",
      "ncm_sugerida": "",
      "ex_tipi_sugerida": "",
      "ncm_definitiva": "96032900",
      "ex_tipi_definitiva": "",
      "status_atual": "classificado",
      "duvida_tecnica": "",
      "resposta_tecnica": "",
      "fundamentacao": "",
      "dt_classificacao": "",
      "data_criacao": "02\/06\/2017 10:58:56",
      "username_criacao": "superdemo"
    }
  ],
  "success": true,
  "message": "ok"
}

Cadastro de produtos

Descritivo dos campos da chamada

Chamada

Campo	PAI	Descrição
cod_interno	products	ID do produto (código interno do Cliente)
origem_produto	products	Origem do produto
descricao	products	Descrição do produto
complemento	products	Complemento do produto
ean	products	EAN do produto
ncm_original	products	NCM do produto
ex_tipi_original	products	Ex TIPI do produto
use_cest	products	Indica se a Systax deve respeitar o código CEST indicado na chamada como parâmetro de tratamento e retorno tributário. Assim, temos 3 possibilidades: 1) Se preenchido com "true" e informado EAN na chamada, a Systax comparará o CEST da chamada com o que será entregue pela Systax, a partir do tratamento por EAN + origem do material. Sendo a CEST compatível, o sistema seguirá com o fluxo padrão, ou seja, cadastro do item novo e geração de regras para ele dentro dos cenários devidos. Caso seja incompatível, o retorno evidenciará a incompatibilidade, apresentando a CEST que a Systax entende correta e o produto não será cadastrado. 2) Se preenchido com "true" e informada apenas NCM (sem EAN) na chamada, a Systax validará se essa CEST é possível para a NCM da chamada. Sendo a CEST compatível, o sistema seguirá com o fluxo padrão, ou seja, cadastro do item novo e geração de regras para ele dentro dos cenários devidos. Caso seja incompatível, o retorno evidenciará a incompatibilidade e o produto não será cadastrado. 3) Se preenchido com "false" ou se não informada a tag, o produto será inserido sem essa informação e o tratamento seguirá como padrão, por EAN ou NCM.
cest	products	CEST do produto (somente é necessário se "use_cest" = "true")

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

Para obter a tabela completa do campo acima, acesse o link: https://documentacao.systax.com.br/books/tabelas-auxiliares/page/remetenteperfil-origem

Descritivo dos campos do retorno

Retorno

Campo	PAI	Descrição
status	/	Status do retorno
itens	/	Quantidade de itens na chamada
itens_ok	/	Quantidade de itens inseridos
position	insert_ids	Posição do item na chamada
cod_interno	insert_ids	ID do produto (Cliente)
origem_produto	insert_ids	Origem do produto
id	insert_ids	ID do produto (Systax)

Tabela de referência para os campos "success" e "message":

Código de retorno	success	message
200	true	ok
400	false false	An error while decoding token Provided token is expired.
401	false	Token not provided

Tabela de referência para os retornos via CEST:

Success	Message	Descrição
true	RETORNO COM SUCESSO	A CEST é válida para a NCM informada e foi possível o tratamento do item com sucesso.
false	CEST INCOMPATIVEL	Pode estar acompanhado das "message_cest" abaixo, para esclarecimento do motivo de incompatibilidade.
		"message_cest": "o produto não possui CEST"
		"message_cest": "lista CEST válida(s): XXXXX"
		"message_cest": "NCM encontrada: XXXXX"
false	CEST NÃO LOCALIZADA	Não encontrou nenhuma CEST
false	NAO FOI POSSIVEL CADASTRAR	Para casos de chamada com use_cest=true e CEST=vazio e não existe produto compatível pre-existente na Systax.
		Este caso, provavelmente precisará de atuação de um consultor Systax e estará acompanhado de uma das "message_cest" abaixo:
		"message_cest": EAN possui CEST
		"message_cest": NCM possui CEST
		"message_cest": não existe produto na base Systax sem CEST para vincular
		"msg":  "item sem configuracao"
		Esta mensagem será exibida quando o produto Systax de referência precisa de tratamento manual de um consultor Systax.

Exemplos de chamada e retorno

Chamada

{
  "products": [
    {
      "cod_interno": "Produto 04",
      "origem_produto": 0,
      "descricao": "Produto 04",
      "complemento": "",
      "ean": "",
      "ncm_original": "",
      "ex_tipi_original": "",

      "use_cest": "true",

       "cest": "2001200"
    },
    {
      "cod_interno": "Produto 05",
      "origem_produto": 0,
      "descricao": "Produto 05",
      "complemento": "",
      "ean": "",
      "ncm_original": "",
      "ex_tipi_original": ""

},
{
      "cod_interno": "Produto 06",
      "origem_produto": 0,
      "descricao": "Produto 06",
      "complemento": "",
      "ean": "",
      "ncm_original": "",
      "ex_tipi_original": "",

       "use_cest": "true",

      "cest": ""

     }
  ]
}

Retorno

{
  "status": "Ok",
  "itens": 3,
  "itens_ok": 3,
  "insert_ids": [
    {
      "position": 0,
      "cod_interno": "Produto 04",
      "origem_produto": 0,
      "id": "11793766"
    },
    {
      "position": 1,
      "cod_interno": "Produto 05",
      "origem_produto": 0,
      "id": "11793767"
    },

   {
      "position": 2,
      "cod_interno": "Produto 06",
      "origem_produto": 0,
      "id": "11793768"

     "message_cest": "validacao_ok" 
    }
  ],
  "itens_error": 0,
  "errors": [],
  "success": true,
  "message": "ok"
}

Consulta de cenários RT

Descrição dos campos de retorno

Campo	Pai	Descrição
id	cenarios	ID identificador do cenário
idCliente	cenarios	ID identificador do cliente
ativo	cenarios	Indica se o cenário está ativo ou não. Preenchimento com "Sim" ou "Não"
idTributo	cenarios	Preenchimento padrão sendo "100" - IBS Master
apelido	cenarios	Descrição do cenário
diasFuturos	cenarios	Prenchimento padrão: "30". Refere-se à vigência da regra entregue.
entSai	cenarios	Tipo entrada/saída sendo "1"para Entradas e "3" para Saídas
naturezaOperacao	cenarios	Código de natureza de operação
finalidade	cenarios	Código de finalidade
ufOrigem	cenarios	UF do remetente
municipioOrigem	cenarios	ID município do remetente
ufDestino	cenarios	UF do destinatário
municipioDestino	cenarios	ID município do destinatário
ufEntrega	cenarios	Sigla da UF de entrega da
		mercadoria
municipioEntrega	cenarios	ID município do entrega
municipioExecucao	cenarios	ID município do execução
perfilOrigem	cenarios	Perfil do remetente
cnaeOrigem	cenarios	CNAE do remetente - Preencher somente se houver orientação específica do time Systax.
perfilDestino	cenarios	Perfil do destinatário
cnaeDestino	cenarios	CNAE do destinatário
prestador	cenarios	Perfil do prestador de um serviço
tomador	cenarios	Perfil do tomador de um serviço
executor	cenarios	Perfil do executor de um serviço
origemProdAlternativo	cenarios	Uso interno Systax
dataCriacao	cenarios	Data de criação do cenário

Tabela de referência para o campo "ent_sai"

ent_sai	Descrição
0	Entrada
1	Saída

Tabelas de referência para os campos "perfilOrigem", "perfilDestino", "finalidade" e "cod_nat_op"

Para obter informações sobre as tabelas dos campos acima, acesse o link: https://documentacao.systax.com.br/books/tabelas-auxiliares

Exemplo de retorno

Cadastro de cenários RT

Descrição dos campos da chamada

CAMPO	PAI	DESCRIÇÃO
idTributo	cenarios	Preenchimento padrão sendo "100" - IBS Master
apelido	cenarios	Descrição do cenário
dias_futuros	cenarios	Prenchimento padrão: "30". Refere-se à vigência da regra entregue.
ent_sai	cenarios	Tipo entrada/saída sendo "1"para Entradas e "3" para Saídas
cod_nat_op	cenarios	Código de natureza de operação
finalidade	cenarios	Código de finalidade
uf_origem	cenarios	UF do remetente
id_mun_origem	cenarios	Código IBGE do município do remetente - Preencher somente para municípios com tributação diferenciada (ex.: municípios localizados na ZFM e ALC).
uf_destino	cenarios	UF do destinatário
id_mun_destino	cenarios	Código IBGE do município do destinatário - Preencher somente para municípios com tributação diferenciada (ex.: municípios localizados na ZFM e ALC).
ufEntrega	cenarios	Sigla da UF de entrega da
		mercadoria
municipioEntrega	cenarios	Código de Município de entrega da operação. Deve ser utilizada a Tabela de código de Município mantida pelo IBGE disponível em: Tabela Códigos dos Municípios - IBGE
municipioExecucao	cenarios	Código de Município de execução da operação. Deve ser utilizada a Tabela de código de Município mantida pelo IBGE disponível em: Tabela Códigos dos Municípios - IBGE
perfilOrigem	cenarios	Perfil do remetente
cnae_origem	cenarios	CNPJ do remetente - Preencher somente se houver orientação específica do time Systax.
perfilDestino	cenarios	Perfil do destinatário
cnae_destinatario	cenarios	CNAE do destinatário - Preencher somente para casos de tributação por CNAE (ex.: operações com destino a MT ou CE).
prestador	cenarios	Perfil do prestador de um serviço
tomador	cenarios	Perfil do tomador de um serviço
executor	cenarios	Perfil do executor de um serviço
origem_produto_ alternativo	cenarios	Preencher somente se houver orientação específica do time Systax.

IMPORTANTE: para os campos em que não for necessário o preenchimento, não enviar a tag ou enviar sem preenchimento.

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

ent_sai	Descrição
1	Entrada
3	Saída

Tabela de referência para os campos "cod_nat_op", "finalidade", "perfilOrigem" e "perfilDestinacao":

Para obter a tabela com os principais códigos dos campos acima, acesse a última versão de documentação no link: https://documentacao.systax.com.br/books/tabelas-auxiliares. Caso tenha alguma situação específica e não localize nas tabelas um código compatível com a necessidade, acione nosso time para que possamos lhe dar orientações assertivas

Descrição dos campos de retorno

Descrição dos campos de retorno

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno
total_itens	/	Quantidade de cenários na chamada
total_ok	/	Quantidade de cenários cadastrados
position	itens_ok	Posição do cenário na chamada
id	itens_ok	ID do cenário cadastrado
total_error	/	Quantidade de cenários não cadastrados
message	itens_error	Mensagem do retorno

Tabela de referência para os campos "success" e "message"

Código de retorno	success	message
200	true	OK
400	false	token_invalid
	false	token_expired
400	false	cenário já cadastrado com esses parâmetros
422	false	"Criado apenas "[quantidade de cenários criados]" cenários, pois a solicitação excede a quantidade de regras enviado para Trial".
500	false	internal_error

Exemplo de chamada e retorno

Chamada

{
    "cenarios": [
        {
            "idTributo": 100,
            "apelido": "Teste - MG-AM-ImpInd-AtcVar",
            "diasFuturos": 30,
            "entSai": 3,
            "naturezaOperacao": 121,
            "finalidade": "",
            "ufOrigem": "MG",
            "municipioOrigem": "4101606",
            "ufDestino": "AM",
            "municipioDestino": "4101606",
            "ufEntrega": "",
            "municipioEntrega": "4101606",
            "municipioExecucao": "4101606",
            "perfilOrigem": "1573",
            "cnaeOrigem": "",
            "perfilDestino": "3044",
            "cnaeDestino": "",
            "prestador": "",
            "tomador": "",
            "executor": "",
            "origemProdAlternativo": "5"
        }
    ]
}

Retorno

{
    "success": true,
    "message": "ok",
    "total_itens": 1,
    "total_ok": 1,
    "itens_ok": [
        {
            "position": 0,
            "id": 56599
        }
    ],
    "total_error": 0,
    "itens_error": []
}

Consulta grupos de produtos

Descrição dos campos de retorno

 

Retorno

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno
record_count	/	Número de registros retornados
id	data	ID do grupo
descricao	data	Descrição do grupo

Tabela de referência para os campo "success" e "message"

Código de retorno	success	message
200	true	OK
400	false	token_invalid
	false	token_expired
500	false	internal error

Exemplos de chamada e retorno

 

Chamada

Retorno

{
  "success": true,
  "message": "Ok",
  "record_count": 1,
  "data": [
    {
      "id": "135146",
      "descricao": "SP-SP-235-137-2"
    }
  ]
}

Associação de produtos e grupos

Conceito

Este recurso é utilizado para limitar a produção de regras para um determinado cenário de forma que a Systax gere para o cliente apenas as regras que, de fato, ele utilizará, evitando o esforço e o custo do recebimento de dados desnecessários.

Em regra, nem todos os produtos do cliente são movimentados em todas as operações (geralmente isso ocorre nas compras), assim esse recurso permite a relação “N-N” entre produtos e cenários. Vejamos o exemplo abaixo de um cliente com 1.000 produtos cadastrados:

Cenários	Grupo de produtos	nº regras a receber da Systax
Compra SP-SP	Comprados de SP	997
Compra RJ-SP	Comprados de RJ	3
Compra AM-SP	Comprados de AM	2
Venda SP-SP	-	1000

Internamente, o sistema terá a lista de produtos que compõem cada grupo (ex.: Comprados do AM: produtos “E” e “F”) e, sempre que um cenário estiver com um grupo associado (ex.: o Grupo de Produtos “Comprados do AM” estará associado ao cenário “Compra AM-SP”), somente serão geradas regras para os produtos movimentados nesta operação (ex.: para o cenário “Compra AM-SP” serão geradas regras apenas para os produtos “E” e “F”).

Descrição dos campos de entrada

Campo	PAI	Descrição
cod_interno	products_groups	ID do produto (Cliente)
origem_produto	products_groups	Origem do produto
descricao	grupos	Descrição do grupo de produtos

Link para consulta da tabela de referência para o campo "origem_produto": https://documentacao.systax.com.br/books/tabelas-auxiliares

Descrição dos campos da chamada

Descrição dos campos de entrada

Campo	PAI	Descrição
cod_interno	products_groups	ID do produto (Cliente)
origem_produto	products_groups	Origem do produto
descricao	grupos	Descrição do grupo de produtos

Link para consulta da tabela de referência para o campo "origem_produto": https://documentacao.systax.com.br/books/tabelas-auxiliares

Descrição dos campos de retorno

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno
itens	/	Quantidade de itens na chamada
itens_ok	/	Quantidade de itens encontrados (existentes)
position	assocs_ok	Posição do item na chamada
cod_interno	assocs_ok	ID do produto (Cliente)
origem_produto	assocs_ok	Origem do produto
descricao	grupos	Descrição do grupo
msg	grupos	Mensagem de retorno referente a associação
itens_error	/	Quantidade de itens

Tabela de referência para o campo "success" e "message"

Código de retorno	sucess	message
200	true	OK
400	false false	token_invalid token_expired
500	false	internal_error

Tabela de referência para o campo "msg"

msg	Descrição
assoc_ok	Associação realizada com sucesso
assoc_already_exists	Associação já existente

Exemplos de chamada e retorno

 

Chamada

{
  "products_groups": [
    {
      "cod_interno": "Produto 02",
      "origem_produto": 0,
      "grupos": [
        {
          "descricao": "GRUPO 1"
        },
                {
          "descricao": "GRUPO 3"
        }
      ]
    },
         {
      "cod_interno": "Produto 03",
      "origem_produto": 0,
      "grupos": [
        {
          "descricao": "GRUPO 1"
        },
                {
          "descricao": "GRUPO 3"
        }
      ]
    }
  ]
}

Retorno

{
  "success": true,
  "message": "ok",
  "itens": 2,
  "itens_ok": 2,
  "assocs_ok": [
    {
      "position": 0,
      "cod_interno": "Produto 02",
      "origem_produto": 0,
      "grupos": [
        {
          "descricao": "GRUPO 1",
          "msg": "assoc_ok"
        },
        {
          "descricao": "GRUPO 3",
          "msg": "assoc_ok"
        }
      ]
    },
    {
      "position": 1,
      "cod_interno": "Produto 03",
      "origem_produto": 0,
      "grupos": [
        {
          "descricao": "GRUPO 1",
          "msg": "assoc_ok"
        },
        {
          "descricao": "GRUPO 3",
          "msg": "assoc_ok"
        }
      ]
    }
  ],
  "itens_error": 0,
  "assocs_error": []
}

Desassociação de produtos e grupos

Descrição dos campos da chamada

Campo	PAI	Descrição
action	-	Contém a palavra "desassociar"
cod_interno	products_groups	ID do produto (Cliente)
origem_produto	products_groups	Origem do produto
descricao	grupos	Descrição do grupo de produtos

Descrição dos campos de retorno

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno
itens	/	Quantidade de itens na chamada
itens_ok	/	Quantidade de itens encontrados (existentes)
desassoc_ok	/	Confirmação da desassociação
position	assocs_ok	Posição do item na chamada
cod_interno	assocs_ok	ID do produto (Cliente)
origem_produto	assocs_ok	Origem do produto
descricao	grupos	Descrição do grupo
msg	grupos	Mensagem de retorno referente a desassociação
itens_error	/	Quantidade de itens
desassocs_error	/	Mensagem de possíveis erros na desassociação

Tabela de referência para o campo "success" e "message"

Código de retorno	sucess	message
200	true	OK
400	false false	token_invalid token_expired
500	false	internal_error

Tabela de referência para o campo "msg"

msg	Descrição
desassoc_ok	Desassociação realizada com sucesso
desassoc_not_found	Desassociação não efetuada

Exemplos de chamada e retorno

Chamada

{
    "action": "desassociar",
    "products_groups": [
        {
            "cod_interno": "10026",
            "origem_produto": 0,
            "grupos": [
                {
                    "descricao": "Grupo Teste V1"
                }
            ]
        },
        {
            "cod_interno": "22970",
            "origem_produto": 0,
            "grupos": [
                {
                    "descricao": "Grupo Teste V1"
                }
            ]
        }
    ]
}

Retorno

   {
    "success": true,
    "message": "ok",
    "itens": 1,
    "itens_ok": 1,
    "desassocs_ok": [
        {
            "position": 0,
            "cod_interno": "10026",
            "origem_produto": 0,
            "grupos": [
                {
                    "id": 1187737,
                    "descricao": "Grupo Teste V1",
                    "msg": "desassoc_ok"
                }
            ]
        }
    ],
    "itens_error": 0,
    "desassocs_error": []
}

Associação/ Desassociação de grupos nos cenários RT

Descrição dos campos da chamada e retorno

 

Chamada

Campo	Descrição
acao	Opções “associar” e “desassociar”
id_cenario	ID do cenário do cliente
nome_grupo	Nome do grupo de produtos

Retorno

Campo	Descrição
success	Status de retorno
message	Mensagem de retorno
itens	Quantidade de itens da chamada
status	Indicador numérico do tipo de status retornado
message	Mensagem relacionado ao status retornado
acao	Opção selecionada de associar ou desassociar
id_cenario	ID do cenário do cliente
nome_grupo	Nome do grupo de produtos

Tabela de referência para o campo “success” e “message”

Código de retorno	sucess	message
200	true	OK
400	false false false	token_invalid token_expired Username ou Password inválido
500	false	internal_error

Tabela de referência para o campo “msg”

Campo	nº ordem	Descrição
Status	0	Sucesso
	1	Cenário não localizado
	2	Grupo de Produtos não localizado
	3	Grupo de Produtos já associado a este cenário
	4	Grupo de Produtos não consta como associado a este cenário

Exemplos de chamada e retorno

Chamada

{
  "items": [
    {
      "acao": "associar",
      "id_cenario_rt": 206829,
      "nome_grupo": "000005"
    },
    {
      "acao": "desassociar",
      "id_cenario_rt": 208547,
      "nome_grupo": "Pentest"
    }
  ]
}

Retorno

{
    "success": true,
    "message": "Ok",
    "items": [
        {
            "status": 0,
            "message": "Sucesso",
            "acao": "associar",
            "id_cenario_rt": 206829,
            "nome_grupo": "000005"
        },
        {
            "status": 0,
            "message": "Sucesso",
            "acao": "desassociar",
            "id_cenario_rt": 208547,
            "nome_grupo": "Pentest"
        }
    ]
}

Exclusão de produtos

Tabela de Códigos

 

Código de retorno	Sucess	Message	Descrição
200	true	deleted	Exclusão realizada com sucesso
400	false	id_not_found	ID informado não foi encontrado
400	false	token_invalid	Token informado não é válido
400	false	token_expired	Token informado expirou
400	false	missing_token	Token não foi informado
500	false	internal_error	Erro interno da API

 

Exemplos de chamada e retorno

 

Chamada

Retorno

{
    "success": true,
    "message": "deleted"
}

Exclusão de cenários RT

Descrição dos campos de retorno

Descrição dos campos de retorno

Campo	PAI	Descrição
success	/	Status do retorno
message	/	Mensagem do retorno

Tabela de referência para os campos "success" e "message"

Código de retorno	success	message
200	true	Sucesso
400	false false	token_invalid token_expired
500	false	internal_error

Exemplos de chamada e retorno

Chamada

Retorno

{

    "success": true,

    "message": "Deletado"

}