Cockpit API's

Introdução
Acesso

Swagger

API's

API Leitura de regras
API Cadastro de produtos
API Associação de grupos/produtos
API - Cadastro de produtos em lote

Informações

Novidades em relação a versão anterior

Introdução

O Cockpit possui algumas API's que permitem a integração do cliente/parceiro com algumas de suas funcionalidades, tais como: cadastro de produtos, associação de grupo/produtos e leitura de regras. Para acessar o Cockpit com uma conta de demonstração, utilize as credenciais abaixo:

URL: https://cockpit.systax.com.br/

Usuário: superdemo@systax.com.br
Senha: super123

OBS: Este manual trata de um conjunto de API's antigas que não devem ser usadas para novas integrações. Abaixo estão os links com as documentações das novas versões:

Cadastros
Manual de cadastro de produtos e Cenários (CFM)

Leitura de regras
API Leitura de Regras

Acesso

Swagger

O Swagger é uma estrutura de software de código aberto que permite aos desenvolvedores projetar, criar, documentar e consumir serviços da Web RESTful. Esse recurso facilita o trabalho dos desenvolvedores, fazendo com que eles tenham um entendimento do objetivo da API, permitindo executar chamadas sem a necessidade de desenvokvimento de códigos.

Swagger: http://wscockpit.systax.com.br/Api/swagger/index.html

Para visualizar as API's próprias do Cockpit selecione "Cockpit - API" na opção "Select a definition" conforme abaixo:

Serão exibidas 4 API's:

Carga Produto - Para o cadastro de um único produto por requisição
Carga Produto em Lote - Para o cadastro de mais de 1 item por requisição
Carga Grupo Produtos - Para a associação de produtos a grupos
Leitura de Regras - Para leitura de regras

API's

API Leitura de regras

Objetivo: Retornar as regras aprovadas do Cockpit.

Método: POST

API Rest / Json: http://wscockpit.systax.com.br/api/api/regras

OBS: NÃO UTILIZAR EM NOVAS INTEGRAÇÕES. PARA NOVAS INTEGRAÇÕES SEGUIR O LINK ABAIXO:
Manual Cockpit API (Bearer)

Descrição dos campos de chamada:

Campo	PAI	Descrição	Obrigatório
id_cenario	/	Primeiro cenário a ser consultado. Pode ser informado 0 ou 1 para que a busca inicie pelo primeiro cenário disponível	Não
codigo_produto	/	Código do produto a partir do qual se deseja realizar a leitura. Pode ser informado 0 ou 1 para iniciar pelo primeiro código disponível	Não
origem_produto	/	Origem do material	Não
paginacao	/	Quantidade de registros exibidos por página com um limite de 100	Não
ponteiro_atualizacao	/	Ponteiro do controle de atualização. Pode ser informado 0 ou 1 para exibir todas as regras	Não
username	/	Usuário do Cockpit	Não
senha	/	Senha do usuário	Não

Campo "origem material":

Código do material	Descrição
0	Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8
1	Estrangeira - Importação direta, exceto a indicada no código 6
2	Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7
3	Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70%
4	Nacional, cuja produção tenha sido feita em conformidade com os PPB de que tratam as legislações citadas nos Ajustes
5	Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%
6	Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural
7	Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural
8	Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%

Exemplos de chamada:

{
"id_cenario": "0",
"codigo_produto": "0",
"origem_produto": "0",
"paginacao": 100,
"ponteiro_atualizacao": "0",
"username": "superdemo@systax.com.br",
"senha": "super123"
}

Descrição dos campos de retorno:

Campo	PAI	Descrição
ponteiro_atualizacao	/	Ponteiro de atualização no formato ano+mês+dia+hora+minuto+segundo
origem	/	Valor fixo "Systax".
sistema	/	Valor fixo "Cockpit".
cod_status	status	Código de retorno
msg_status	status	Mensagem de retorno

Tabela de referência para os campos "cod_status" e "msg_status":

cod_status	msg_status
0	Sucesso
1	LoginSenhaInvalido
8	UsuarioSemCliente
9	ClienteSemConnectionString
10	FalhaNaAplicacao

Exemplos de retorno:

{
"cenario": [
{
"ent_sai": "3",
"id_cenario": "152275",
"apelido": "Revenda_PR_TO_Importador_CFC",
"uf_origem": "PR",
"uf_destino": "TO",
"origem": "24",
"destinacao": "3",
"cod_natureza_operacao": "712",
"retorno": [
{
"cod_prod": "100500",
"descricao": "ROLAMENTO - AGULHAS",
"ean": "00000000000000",
"ncm": "84824000",
"origem_produto": "1",
"cfop": "6106",
"cest": "0104900",
"icms": {
"cst": "10",
"bc_composicao": 1,
"bc_composicao_sn_especial": 0,
"bc_composicao_fcp": 0,
"aliquota": "4.0000",
"generico": "tributos_aproximados_Estadual=18.00|tributos_aproximados_Federal=19.35",
"vigencia_de": "2017-10-01T00:00:00",
"dispositivo_legal": "Art. 8º, §2º, I, do RICMS/PR. Art. 18, III, do RICMS/PR.",
"inf_adicionais": "Art. 61 e Item 11 do Anexo XXI do RICMS/TO. Art. 8º, §2º, I, do RICMS/PR. Art. 18, III, do RICMS/PR. Protocolo ICMS CONSELHO NACIONAL DE POLÍTICA FAZENDÁRIA - CONFAZ nº 97 de 09.07.2010",
"icms_st": {
"bc_composicao": 71,
"bc_composicao_fcp": 0,
"aliquota_st": "18.0000",
"vigencia_de": "2020-02-01T00:00:00",
"dispositivo_legal": "Protocolo ICMS CONSELHO NACIONAL DE POLÍTICA FAZENDÁRIA - CONFAZ nº 97 de 09.07.2010. Art. 61 e Item 11 do Anexo XXI do RICMS/TO"
},
"estatistica": "A51"
},
"ipi": {
"cst": "50",
"cenq": "999",
"bc_composicao": 57,
"aliquota": "12.0000",
"generico": "ipi_cenq=999",
"vigencia_de": "2017-03-09T00:00:00",
"dispositivo_legal": "Art. 190 do RIPI/2010 e Decreto nº 8.950/2016"
},
"pis": {
"cst": "01",
"bc_composicao": 2,
"aliquota": "1.6500",
"vigencia_de": "2002-12-01T00:00:00",
"dispositivo_legal": "Art. 1º da Lei nº 10.637/2002. Art. 2º, caput, da Lei nº 10.637/2002"
},
"cofins": {
"cst": "01",
"bc_composicao": 2,
"aliquota": "7.6000",
"vigencia_de": "2004-02-01T00:00:00",
"dispositivo_legal": "Art. 1º da Lei nº 10.833/2003. Art. 2º, caput, da Lei nº 10.833/2003"
}
}
]
}
],
"ponteiro_atualizacao": "20210514111645",
"origem": "Systax",
"sistema": "Cockpit",
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}

API's

API Cadastro de produtos

Objetivo: Cadastrar um único produto por requisição no Cockpit.

Método: POST

API Rest / Json: http://wscockpit.systax.com.br/api/api/carga_produto

OBS: NÃO UTILIZAR EM NOVAS INTEGRAÇÕES. PARA NOVAS INTEGRAÇÕES SEGUIR O LINK ABAIXO:
Manual de cadastro de produtos e Cenários (CFM)

Descrição dos campos de chamada:

Campo	PAI	Descrição	Obrigatório
codigo_produto	carga_produto	Código do produto	Sim
ncm	carga_produto	Classificação fiscal do produto	Não
descricao	carga_produto	Descrição do produto	Não
orig	carga_produto	Origem do produto	Não
ex_tipi	carga_produto	Código EX da TIPI	Não
cean	carga_produto	Código de barras do produto	Não
med_lista	carga_produto	Utilizado apenas para medicamentos. Vide tabela abaixo	Não
med_tipo	carga_produto	Utilizado apenas para medicamentos. Vide tabela abaixo	Não
complemento	carga_produto	Complemento da descrição do produto.	Não
finalidade	carga_produto	Não utilizar. Desenvolvido para difereciar a finalidade de cadastro do item.	Não
acao	carga_produto	Ação (cadastrar ou desativar)	Não
username	/	Usuário do Cockpit	Não
senha	/	Senha do usuário	Não

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

Código	Descrição
0	Positiva
1	Negativa
2	Neutro

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

Código	Descrição
R	Referência
G	Genérico
S	Similar
O	Outros

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

acao	descrição
1	Cadastrar produto
2	Desativar produto

Tabela de referência para os campos "origem" e "finalidade"

Acesse a última versão do documento no link: Tabelas Auxiliares para obter os códigos de origem de materiais e finalidade.

Exemplos de chamada:

{
"carga_produto": {
   "codigo_produto": "codigo",
   "ncm": "02034044",
  "descricao": "descricao do produto",
"orig": "0",
"acao": "1"
},
"username": "superdemo@systax.com.br",
"senha": "super123"
}

Descrição dos campos de retorno:

Campo	PAI	Descrição
cpr_codi	/	Código interno da Systax
origem	/	Valor fixo "Systax"
sistema	/	Valor fixo "Cockpit"
cod_status	status	Código de retorno
msg_status	status	Mensagem de retorno

Tabela de referência para os campos "cod_status" e "msg_status"

cod_status	msg_status
0	Sucesso
1	LoginSenhaInvalido
8	UsuarioSemCliente
9	ClienteSemConnectionString
10	FalhaNaAplicacao
13	ParametrosInvalidos

Exemplos de retorno:

{
"cpr_codi": 57929,
"origem": "Systax",
"sistema": "Cockpit",
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}

Observação 1: Essa API faz o cadastro de apenas 1 item por requisição. Caso haja a necessidade de cadastrar em lote, veja o tópico "API - Cadastro de produtos em Lote".

Observação 2: O produto demora em média 30 minutos para ser incluído no cadastro da Systax. Após esse tempo, será possível visualizar a carga do produto no Cockpit, porém, na tela de "Consulta de Produtos", o novo produto será visualizado somente após o processamento e entrega de alguma regra tributária associada á ele.

API's

API Associação de grupos/produtos

Objetivos: Associar um produto a um grupo de produtos, e também, pode ser utilizada para a criação de cenários.

Comandos: uma chamada pode resultar em até 4 ações sistêmicas:

1) Associar o produto a grupo de produtos.

2) Se o grupo não existir a API cria o grupo.

3) Se o nome do grupo estiver no formato ufOrigem - ufDestino - naturezaOp - perfilOrigem - perfilDestino - Finalidade (que identifica um cenário) a API irá associar o grupo no cenário.

Exemplo: SP-SP-120-1-140-175. Obtenha os principais códigos e exemplos acessando o link: Tabelas Auxiliares

Importante: O parâmetro "Finalidade" é obrigatório para cenários de entrada e não deve ser informado para cenários de saída.

4) Se o cenário não existir com os parâmetros do item 3, a API irá criar o cenário.

Grupo de Produtos - 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:

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

Método: POST

API Rest / JSON: http://wscockpit.systax.com.br/api/api/carga_grupo_produto

OBS: NÃO UTILIZAR EM NOVAS INTEGRAÇÕES. PARA NOVAS INTEGRAÇÕES SEGUIR O LINK ABAIXO:
Manual de cadastro de produtos e Cenários (CFM)

Descrição dos campos de chamada:

Campo	PAI	Descrição	Obrigatório
codigo_produto	carga_grupo_produto	Código do produto	Sim
origem_produto	carga_grupo_produto	Origem do produto	Não
grupo	carga_grupo_produto	Código do grupo de produtos	Não
acao	carga_grupo_produto	Ação (cadastrar ou desativar)	Não
username	/	Usuário do Cockpit	Não
senha	/	Senha do usuário	Não

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

Acesse o link : Tabelas Auxiliares para obter a tabela de origem de materiais.

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

acao	descrição
1	Cadastrar produto
2	Desativar produto

Exemplos de chamada:

{
"carga_grupo_produto": {
    "codigo_produto": "codigo",
    "origem_produto": 0,
    "grupo": "nome do grupo",
    "acao": 1
},
"username": "superdemo@systax.com.br",
"senha": "super123"
}

Descrição dos campos de retorno:

Campo	PAI	Descrição
origem	/	Valor fixo "Systax"
sistema	/	Valor fixo "Cockpit"
cod_status	status	Código de retorno
msg_status	status	Código de retorno

Tabela de referência para os campos "cod_status" e "msg_status"

cod_status	msg_status
0	Sucesso
1	LoginSenhaInvalido
8	UsuarioSemCliente
9	ClienteSemConnectionString
10	FalhaNaAplicacao

Exemplos de retorno:

{
"origem": "Systax",
"sistema": "Cockpit",
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}

API's

API - Cadastro de produtos em lote

Objetivo: Cadastrar mais de 1 produto em uma única requisição.

Método: POST

API Rest / Json: https://wscockpit.systax.com.br/api/api/carga_produto/lote

OBS: NÃO UTILIZAR EM NOVAS INTEGRAÇÕES. PARA NOVAS INTEGRAÇÕES SEGUIR O LINK ABAIXO:
Manual de cadastro de produtos e Cenários (CFM)

Descrição dos campos de chamada:

Campo	PAI	Descrição	Obrigatório
codigo_produto	carga_produto	Código do produto	Sim
ncm	carga_produto	Classificação fiscal do produto	Não
descricao	carga_produto	Descrição do produto	Não
orig	carga_produto	Origem do produto	Não
ex_tipi	carga_produto	Código EX da TIPI	Não
cean	carga_produto	Código de barras do produto	Não
med_lista	carga_produto	Utilizado apenas para medicamentos. Vide tabela abaixo	Não
med_tipo	carga_produto	Utilizado apenas para medicamentos. Vide tabela abaixo	Não
complemento	carga_produto	Complemento do produto	Não
finalidade	carga_produto	Código da finalidade do cenário	Não
acao	carga_produto	Ação (cadastrar ou desativar)	Não
username	/	Usuário do Cockpit	Não
senha	/	Senha do usuário	Não

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

Código	Descrição
0	Positiva
1	Negativa
2	Neutro

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

Código	Descrição
R	Referência
G	Genérico
S	Similar
O	Outros

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

acao	Descrição
1	Cadastrar produto
2	Desativar produto

Tabela de referência para os campos "origem" e "finalidade"

Acesse a última versão de documentação no link: Tabelas Auxiliares para obter os códigos de origem de materiais e finalidade.

Exemplos de chamada:

{
"carga_produtos": [
{
       "acao": "1",
       "codigo_produto": "código",
       "orig": "0",
       "ncm": "85365090",
       "cean": "7898246050780",
       "descricao": "descrição do produto"
   },
   {
       "acao": "1",
       "codigo_produto": "código",
       "orig": "0",
       "ncm": "85365090",
       "cean": "7898246050780",
       "descricao": "descrição do produto"
   },
   {
       "acao": "1",
       "codigo_produto": "código",
       "orig": "0",
       "ncm": "85365090",
       "cean": "7898246050780",
       "descricao": "descrição do produto"
   },
   {
       "acao": "1",
       "codigo_produto": "código",
       "orig": "0",
       "ncm": "85365090",
       "cean": "7898246050780",
       "descricao": "descrição do produto"
   }
],
"username": "superdemo@systax.com.br",
"senha": "super123"
}

Descrição dos campos de retorno:

Campo	PAI	Descrição
cpr_codi	/	Código interno da Systax
origem	/	Valor fixo "Systax"
sistema	/	Valor fixo "Cockpit"
cod_status	status	Código de retorno
msg_status	status	Mensagem de retorno

Tabela de referência para os campos "cod_status" e "msg_status"

cod_status	msg_status
0	Sucesso
1	LoginSenhaInvalido
8	UsuarioSemCliente
9	ClienteSemConnectionString
10	FalhaNaAplicacao
13	ParametrosInvalidos

Exemplos de retorno:

{
"cpr_codi": [
57930
],
"origem": "Systax",
"sistema": "Cockpit",
"status": {
"cod_status": 0,
"msg_status": "Retorno com sucesso. "
}
}

Observação 1: A API suporta até 100 itens por requisição.

Informações

Novidades em relação a versão anterior

Esta versão introduz as seguintes mudanças em relação à versão anterior:

Inclusão do campo " grupo_produto_associado" no retorno da API de regras. Esse campo informa em qual grupo o produto foi associado.