Introdução à API do WMS
Este modelo de integração permite que a aplicação WMS se comunique diretamente com a aplicação ERP via web services. Os métodos disponibilizados para consumo pelo WMS irão permitir que o registro criado no ERP seja integrado ao WMS em Real-Time (tempo-real), ou seja, integração síncrona.
Comunicação e autenticação:
Para esta comunicação o WMS disponibiliza a informação do caminho (URL) das suas respectivas aplicações. Essas informações serão específicas para cada modelo de integração REST/SOAP
Exemplo de formato:
Para API-REST
o método utilizado será sempre o (POST), sendo que alguns parâmetros de comunicação serão inseridos no Headers da requisição, e outros no Body. O retorno do serviço consumido será denominado "Response" e, quando efetuado com sucesso, retorna o status "200". Doravante, serão definidos os parâmetros conforme exemplo:
Exemplo de URL para acessar os métodos disponibilizados pela API
http://ip_servidor:9090/cyberweb/api/servico/nomeServico
Exemplo de URL para acessar os métodos disponibilizados pela API
http://ip_servidor:9090/SyncWS/SyncWS?wsdl
Exemplo de parâmetros utilizados pela API
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<loginSync xmlns="http://soap.cyber/">
<modulo xmlns="">SYNC</modulo>
<numeroDeposito xmlns="">1</numeroDeposito>
<loginName xmlns="">user_wms</loginName>
<password xmlns="">123@bcd</password>
<address xmlns="">192.168.0.110</address>
</loginSync>
</Body>
</Envelope>
Campos não obrigatórios:
Os campos não obrigatórios, quando não enviados nos parâmetros de integração, receberão valor padrão ou null.
Formatação das informações
Os dados contidos nos parâmetros são meramente elucidativos. A exemplificação de cada parâmetro é formada por campo : valor
, e seguida da explicação, em cinza e itálico. A explicação é formada pelo tipo do dado, que está definido entre parênteses e, logo após, seu respectivo uso. Algumas informações estão formatadas em json.
Mensagens de Retorno:
As mensagens de retorno, doravante denominadas (RC Response Code
), foram desolvidas seguindo um padrão de numeração, para eventos rastreados, e utilizando o !42
para eventos não rastreados.
Exemplo de RC do método integrarCliente
- 1 - Inserido;
- 2 - Alterado;
- 3 - Excluído;
- !4 - Não inserido (depósito informado não possui configuração);
- !5 - Não inserido (ERPID vazio);
- !7 - Não inserido (nome vazio);
- !8 - Não inserido (endereço vazio);
- !9 - Não inserido (cep vazio);
- !10 - Não inserido (cidade/uf vazio);
- !42 - Erro não cadastrado (informações no log do servidor).
Atenção
Quando houver exclamação "!" antes do número, significa que a transação não foi concluída.
Significado dos símbolos
Símbolo | Descrição |
---|---|
varchar(30) | Caractere variável de tamanho máximo 30. Campo utilizado para envio de texto. |
number(10) | Número de tamanho máximo 10. Campo utilizado para envio de número inteiro. |
number(15,4) | Número de tamanho máximo 15,4. Campo utilizado para envio de número com ponto flutuante. |
boolean | Booleano. Campo utilizado para envio de valores true ou false. |
date(8) | Data de tamanho máximo 8. Campo utilizado para envio de data. |
datetime | Data e hora. Campo utilizado para envio de data e hora. |
**arraylist(entidade) ** | Lista de uma entidade. Campo utilizado para envio de uma lista de entidades. |
ACCEPT | Aceitar a operação sendo realizada. |
CANCEL | Cancelar a operação sendo realizada. |