Você está na página 1de 6

WebService Clculo de Frete

Total Express
Verso 1.0 - Maro/ 2014

Verso 1.0 - Janeiro/ 2014

Total Express - Tex Courier Ltda.

ti@totalexpress.com.br
www.totalexpress.com.br
Contedo

1. Introduo ........................................................................................................................................... 3
1.1. O que um WebService? ............................................................................................................. 3
1.2 Disponibilidade .............................................................................................................................. 3
1.3 Responsabilidades do usurio ....................................................................................................... 3
1.4 Responsabilidades da TOTAL EXPRESS .......................................................................................... 4
2. Como utilizar o servio ........................................................................................................................ 4
3. Dados tcnicos..................................................................................................................................... 4
3.1. Segurana na transmisso ............................................................................................................ 4
4. Recursos do Webservice ..................................................................................................................... 4
5. Mtodo calcularFrete .......................................................................................................................... 5
5.1 Descrio da estrutura calcularFreteRequest ........................................................................... 6
5.1 Descrio da estrutura calcularFreteResponse ......................................................................... 6

2
WebService Total Express
1. Introduo
O WebService TOTAL EXPRESS foi criado para facilitar a troca de informaes com seus clientes de
forma prtica e segura.

1.1. O que um WebService?


Trata-se de uma soluo utilizada na integrao de sistemas que se d pela comunicao entre
diferentes aplicaes, atravs da adoo de padres especficos moldados de acordo com a
necessidade do usurio.

Em nosso caso, de um lado temos os servidores da TOTAL EXPRESS que disponibilizam o servio de
WebService, no papel de Service Provider, e do outro temos os clientes da empresa requisitando
servios digitais, ou seja, enviando e recebendo informaes. O WebService da TOTAL EXPRESS utiliza
o protocolo de troca de dados SOAP.

1.2 Disponibilidade
O WebService est disponvel o tempo todo (24 horas por dia, 7 dias por semana), exceto em
momentos em que ocorram situaes de manuteno ou falha tcnica.

Nos casos de manuteno, a TOTAL EXPRESS se compromete a notificar os usurios do WebService


com a mxima antecedncia possvel, mas se reserva ao direito de realizar manutenes
emergenciais sem que haja tal comunicao. A TOTAL EXPRESS se reserva ao direito de alterar o IP
dos servidores sempre que necessrio, e sempre instrui seus clientes a utilizar a URL de acesso em
suas configuraes.

Por se tratar de um servio sncrono, em cada transmisso o sistema cliente poder saber se houve
alguma falha, sem que seja necessrio entrar em contato com a equipe tcnica da TOTAL EXPRESS.

1.3 Responsabilidades do usurio


O usurio do servio dever estar ciente e concordar com suas responsabilidades:

Respeitar as normas de segurana colocadas pela TOTAL EXPRESS. IMPORTANTE!


Garantir a integridade das informaes enviadas;
Realizar o uso consciente, evitando sobrecarga de processamento;
Construir uma ferramenta eficaz de consulta, capaz de confirmar a transmisso atravs da
resposta obtida. Havendo erros, caber ao cliente identific-los e trat-los;

O USO INDEVIDO PODE ACARRETAR SUSPENSO DO SERVIO SEM PRVIO AVISO!

3
1.4 Responsabilidades da TOTAL EXPRESS
A TOTAL EXPRESS assegura acessibilidade e trafegabilidade no webservice, porm fica isenta de
qualquer responsabilidade em caso de instabilidades decorrentes de problemas sistmicos ou de
infraestrutura.

2. Como utilizar o servio


Para se tornar um utilizador do WebService, o cliente dever preparar o ambiente tcnico conforme
descrito nesse manual, e entrar em contato com o departamento de tecnologia da TOTAL EXPRESS,
solicitando preparao do ambiente de testes. Nesse momento o cliente dever informar os
endereos de IP de onde as transmisses sero originadas.

A equipe tcnica da TOTAL EXPRESS fornecer ao cliente as seguintes informaes: endereo de


transmisso (inclusive endereo do arquivo WSDL), usurio e senha.

3. Dados tcnicos
Protocolo de transmisso: SOAP 1.1
Mais informaes: http://www.w3.org/TR/soap11/

Codificao do contedo: UTF-8


Mais informaes: http://tools.ietf.org/html/rfc5198

Tipo de servio: Sncrono (tempo real): o processamento da solicitao de servio


concludo na mesma conexo, com a devoluo de uma mensagem com
o resultado do processamento solicitado. Essa mensagem poder ser de
sucesso ou de erro.

3.1. Segurana na transmisso


Para assegurar a autenticidade da transmisso, o WebService TOTAL EXPRESS trabalha com
protocolo HTTPS. Se o cliente no possuir SSL, o webservice aceitar conexes apenas a partir de
endereos IP previamente cadastrados (mximo de 5 endereos) e tambm autenticao do usurio,
via HTTP. Subentende-se, portanto, que o cliente dever possuir ao menos um endereo IP fixo. Se o
cliente possuir SSL, o webservice aceitar conexes apenas com autenticao de usurio, sem a
necessidade do IP.

4. Recursos do Webservice
calcularFrete Permite ao cliente realizar o clculo do valor total de um frete (servio) de
uma encomenda

4
5. Mtodo calcularFrete
Permite ao cliente realizar clculo do valor total do frete (servio) de uma determinada encomenda.
A chamada desse mtodo deve ser feita enviando uma estrutura complexa calcularFreteRequest.
Os dados retornados viro no formato de uma estrutura complexa calcularFreteResponse.

5
5.1 Descrio da estrutura calcularFreteRequest
# Nome Descrio Preenchimento Tipo Tam. Observaes
tns:calcularFreteRequest
EXP = Expresso / ESP = Especial / PRM = Premium / STD = Standard.
1 TipoServico Tipo de Servio Mandatrio xsd:string 3 O servio deve estar previamente cadastrado no ICS
2 CepDestino CEP de destino da Encomenda Mandatrio xsd:nonNegativeInteger 8
3 Peso Peso da Encomenda Mandatrio xsd:decimal 3,2 Nmerico, com 2 casas decimais. Ex: 12,34
4 ValorDeclarado Valor Declarado da Encomenda Mandatrio xsd:decimal 15,2
5 TipoEntrega Tipo de Entrega Mandatrio xsd:nonNegativeInteger 1 0 = Entrega Normal (padro) / 1 = GoBack / 2 = RMA
Caso haja o servio de COD nesta encomenda, informar TRUE. Se no
6 ServicoCOD Servio de COD (Cash On Delivery) Opcional xsd:boolean 1 houver, informar FALSE.
7 Altura Altura da Caixa da Encomenda (Cubagem) Opcional xsd:nonNegativeInteger 4 Tamanho em centmetros
8 Largura Largura da Caixa da Encomenda (Cubagem) Opcional xsd:nonNegativeInteger 4 Tamanho em centmetros
9 Profundidade Pronfudidade da Caixa da Encomenda (Cubagem) Opcional xsd:nonNegativeInteger 4 Tamanho em centmetros

5.1 Descrio da estrutura calcularFreteResponse


# Nome Descrio Preenchimento Tipo Tam. Observaes
tns:calcularFreteResponse
0 Cliente no autorizado a realizar o procedimento
1 Processado com sucesso
Obs: Processamento realizado com sucesso.
2 Sistema indisponvel no momento
1 CodigoProc Cdigo do Processamento Obrigatrio xsd:nonNegativeInteger 1 Obs: O cliente dever realizar a transmisso novamente mais tarde.
3 Erro sistmico por parte da TOTAL EXPRESS
Obs: O cliente dever realizar a transmisso novamente mais tarde.
4 Erro na validao XSD
Obs: O cliente dever verificar o contedo enviado.
2 DadosFrete Dados do Frete Calculado Opcional tns:DadosFrete Se no houver itens, o campo no ser enviado.
3 ErroConsultaFrete Erros na transmisso Opcional xsd:string Se no houver erros na transmisso, o campo no ser enviado.
tns:DadosFrete
4 Prazo Prazo de Entrega da Encomenda Mandatrio xsd:NonNegativeInteger 3 Prazo em dias
5 ValorServico Valor total do servio de frete Mandatrio tns: decimal 15,2 Valor total do servio (valor frete + valor gris + valor advalorem)