Manual da API de Documentação
Manual contendo as últimas atualizações efetuadas em 17/02/2021.
- Introdução
- Acesso
- Autenticação
- Descrição dos campos da chamada e retorno
- Exemplos de chamada e retorno
Introdução
Essa API recupera os cenários do cliente cadastrados no ADMIN em formato XML.
Acesso
Método: POST
WSDL: http://sp.systax.com.br/webservice/systax_erp_cenarios.php?wsdl
Autenticação
As informações de autenticação são passadas nos campos "username" e "senha" na estrutura XML da chamada. Essas credenciais são as mesmas utilizadas no site Systax e do serviço de parametrização fiscal.
Descrição dos campos da chamada e retorno
Chamada
|
Campo |
Descrição |
|
username |
Usuário cadastrado no site Systax e serviço de parametrização fiscal |
|
senha |
Senha do usuário cadastrado no site Systax e serviço de parametrização fiscal |
Retorno
|
Campo |
Descrição |
|
cod_status |
Código de retorno (vide tabela abaixo) |
|
msg_status |
Mensagem do código de retorno (vide tabela abaixo) |
|
cenario |
XML com lista de cenários |
Lista de códigos e mensagens de retorno
|
cod_status |
msg_status |
|
0 |
Retorno com sucesso |
|
1 |
Login ou senha inválida |
|
4 |
Seu período de acesso expirou em [DATA_EXP] |
|
5 |
Crédito insuficiente, seu saldo é [SALDO] |
|
6 |
Código NCM não localizado na tabela ou não teve atualizaçõe |
Exemplos de chamada e retorno
Chamada
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:systax_erp_cenario">
<soapenv:Header/>
<soapenv:Body>
<urn:systax_erp_cenario>
<username> usuário</username>
<senha>senha</senha>
</urn:systax_erp_cenario>
</soapenv:Body>
</soapenv:Envelope>
Retorno
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:systax_erp_cenario">
<SOAP-ENV:Body>
<ns1:systax_erp_cenarioResponse xmlns:ns1="urn:systax_erp_cenario">
<body xsi:type="tns:systax_ret">
<origem>Systax</origem>
<sistema>ERP - Cen&aacute;rios</sistema>
<status>
<cod_status>0</cod_status>
<msg_status>Retorno com sucesso.</msg_status>
</status>
<cenario><![CDATA[
<?xml version="1.0"?>
<cenario>
<retorno>
<id_cenario>1443506</id_cenario>
<descricao>Compra-CE-DF-Importador-Varejo</descricao>
<uf_origem>CE</uf_origem>
<uf_destino>DF</uf_destino>
<grupo>CE-DF-121-24-140</grupo>
<dias_futuros>30</dias_futuros>
<ent_sai>1</ent_sai>
<finalidade>569</finalidade>
<cod_nat_op>121</cod_nat_op>
<origem>24</origem>
<destinacao>140</destinacao>
</retorno>
<retorno>
<id_cenario>1442591</id_cenario>
<descricao>Compra-RJ-DF-importador-Varejo</descricao>
<uf_origem>RJ</uf_origem>
<uf_destino>DF</uf_destino>
<grupo>RJ-DF-121-24,828-140</grupo>
<dias_futuros>30</dias_futuros>
<ent_sai>1</ent_sai>
<finalidade>569</finalidade>
<cod_nat_op>121</cod_nat_op>
<origem>24,828</origem>
<destinacao>140</destinacao>
</retorno>
</cenario>
</body>
</ns1:systax_erp_cenarioResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>