Académique Documents
Professionnel Documents
Culture Documents
Manual de utilizao
Verso 1.1
15 de outubro de 2015
Contedo
Apresentao ...................................................................................................................... 3
Introduo............................................................................................................................ 4
Consideraes preliminares ................................................................................................ 5
Padres tcnicos ............................................................................................................. 5
pontualcargas/servicos/ws/nd.............................................................................................. 6
pontualcargas/servicos/ws/nd/get .................................................................................... 7
pontualcargas/servicos/ws/nd/getByNF ......................................................................... 11
pontualcargas/servicos/ws/nd/trackingByND ................................................................. 15
pontualcargas/servicos/ws/nd/trackingByNF.................................................................. 18
Tabelas de Cdigos internos ............................................................................................. 21
Apresentao - 3
Apresentao
O Web Service pontualcargas.com/servicos/ws foi desenvolvido no intuito de
disponibilizar para os Clientes da empresa, servios que possam facilitar a integrao
entre os sistemas proprietrios dos clientes e o banco de dados da empresa Encomendas
e Transporte de Cargas Pontual Ltda., fornecendo a estes clientes, um servio
diferenciado de informaes relativos ao manifesto e acompanhamento de suas cargas.
Introduo
Este manual tem por objetivo a definio de especificaes e critrios tcnicos para a
integrao entre o portal da Pontual e os sistemas de informaes de seus clientes.
Tendo sido desenvolvido para funcionar na Internet, para acessar este servio, o Cliente
ir precisar de um servio de acesso Internet (contratado por conta prpria), alm de
recursos prprios de programao para utilizar os servios e tratar a informao
retornada.
Com este servio, o cliente poder consultar os dados das cargas e do rastreamento.
Consideraes preliminares - 5
Consideraes preliminares
Por se tratar de um acesso diretamente ao banco de dados da empresa, o cliente dever
utilizar o seu Cdigo de Conta Corrente na Pontual e da senha de acesso aos Servios
on-line do site da Pontual para que a execuo da solicitao seja autenticada e
registrada no servidor.
Para que o cliente saiba qual o nmero de sua conta corrente na Pontual basta entrar
em contato com o Departamento Comercial na matriz da empresa pelo nmero
(61) 2192-1200. Aproveite para confirmar se o seu endereo eletrnico (e-mail) est
atualizado nos cadastros da empresa, pois por meio dele que o cliente receber sua
senha de acesso.
Padres tcnicos
Este servio de Web Service foi desenvolvido utilizando o padro SOAP 1.2. Para
documentao consultar http://www.w3.org/TR/soap/.
pontualcargas/ws/nd - 6
pontualcargas/servicos/ws/nd
Este Web Service disponibiliza servios de consulta e acompanhamento de Notas de
Despacho Eletrnicas. Com ele possvel consultar cargas no sistema, assim como
consultar os eventos de rastreamento das cargas, conforme os mtodos detalhados a
seguir.
Os detalhes do Web Service (WSDL Web Services Description Language) podem ser
obtidos atravs do endereo abaixo:
http://www.pontualcargas.com.br/servicos/ws/nd?wsdl
pontualcargas/ws/nd/get - 7
pontualcargas/servicos/ws/nd/get
Consultar os dados de uma Nota de Despacho no banco de dados da empresa atravs do
nmero da mesma.
1. Endereo
http://www.pontualcargas.com.br/servicos/ws/nd/get
Exemplo:
<?xml version="1.0"?>
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:q0="http://www.pontualcargas.com/servicos/ws/nd">
<soapenv:Header/>
<soapenv:Body>
<q0:get>
<login>
<password>********</password>
<username>100</username>
</login>
<nd>5773882</nd>
</q0:get>
</soapenv:Body>
</soapenv:Envelope>
Onde:
faultcode faultstring
soap:Server Usurio ou senha incorreta!
Verifique os dados de login (usurio e senha).
soap:Server Nota de Despacho (nd) no encontrada!
A ND no foi encontrada, atravs do nmero da Nota de Despacho, para a Conta
Corrente informada.
pontualcargas/ws/nd/get - 8
Onde:
# Campo Ele Pai Tipo Descrio
AR01 getResponse Raiz - - TAG raiz
AR02 nd E AR01 nd Estrutura de dados da Nota de Despacho
AR03 apolicesegproprio E AR02 string Se o Cliente possui aplice de seguro
prpria ou no:
S ou N
AR04 codcliente E AR02 long Cdigo do Cliente junto Pontual (Conta
Corrente)
AR05 coleta E AR02 boolean Se foi utilizado servio de Coleta:
S ou N
AR06 coletadatahora E AR02 dateTime Data e hora em que a carga foi coletada:
DD-MM-YYYYTHH:MM:SS[TIME_ZONE]
AR07 coletador E AR02 string Nome do funcionrio da Pontual que efetuou
a coleta da carga
AR08 confirmacaodatahora E AR02 dateTime Data e hora em que a carga foi entregue ao
destinatrio:
DD-MM-YYYYTHH:MM:SS[TIME_ZONE]
AR09 confirmacaonome E AR02 string Nome de quem recebeu a carga no destino
AR10 confirmacaorg E AR02 string Nmero do documento de quem recebeu a
carga no destino
AR11 conteudo E AR02 string Descrio do contedo dos volumes da
carga
AR12 datahora E AR02 dateTime Data e hora que a ND foi emitida:
DD-MM-YYYYTHH:MM:SS[TIME_ZONE]
AR13 destinatario E AR02 endereco Detalhes do Destinatrio
AR14 bairro E AR13 string Bairro do endereo
AR15 cep E AR13 int CEP do endereo
AR16 cnpj E AR13 string CNPJ, se Pessoa Jurdica
AR17 cpf E AR13 string CPF, se Pessoa Fsica
AR18 fax E AR13 string Nmero do FAX
AR19 fone E AR13 string Nmero do Telefone
AR20 ie E AR13 string Nmero de Inscrio Estadual, se
Pessoa Jurdica
AR21 logradouro E AR13 string Endereo
AR22 nome E AR13 string Nome
AR23 destino E AR02 localidade Detalhes da cidade de Destino
AR24 estado E AR23 string Nome da Unidade Federativa
AR25 id E AR23 long Nmero da Cidade (cdigo interno da
Pontual)
AR26 name E AR23 string Nome da Cidade
AR27 siglaLocalidade E AR23 string Sigla da Localidade
AR28 uf E AR23 string Sigla da Unidade Federativa
AR29 dimensoes E AR02 string Detalhes das dimenses dos volumes da
carga
AR30 emergencia E AR02 boolean Se foi utilizado servio de Emergncia:
S ou N
AR31 entrega E AR02 boolean Se foi utilizado servio de Entrega:
S ou N
AR32 especie E AR02 string Descrio da espcie da carga
AR33 id E AR02 long Nmero da Nota de Despacho
AR34 nomecliente E AR02 string Nome do Cliente (Conta Corrente)
AR35 notafiscal E AR02 string Detalhes de documentos fiscais relativos
carga
AR36 obs E AR02 string Observaes diversas sobre a ND
AR37 origem E AR02 localidade Detalhes da cidade de Origem
AR38 estado E AR37 string Nome da Unidade Federativa
AR39 id E AR37 long Nmero da Cidade (cdigo interno da
Pontual)
AR40 name E AR37 string Nome da Cidade
AR41 siglaLocalidade E AR37 string Sigla da Localidade
pontualcargas/ws/nd/get - 10
pontualcargas/servicos/ws/nd/getByNF
Consultar os dados de uma Nota de Despacho no banco de dados da empresa atravs do
nmero de Documento Fiscal informado.
1. Endereo
http://www.pontualcargas.com.br/servicos/ws/nd/getByNF
Exemplo:
<?xml version="1.0"?>
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:q0="http://www.pontualcargas.com/servicos/ws/nd">
<soapenv:Header/>
<soapenv:Body>
<q0:getByNF>
<login>
<password>********</password>
<username>100</username>
</login>
<nf>9310</nf>
</q0:getByNF>
</soapenv:Body>
</soapenv:Envelope>
Onde:
faultcode faultstring
soap:Server Usurio ou senha incorreta!
Verifique os dados de login (usurio e senha).
soap:Server Nota de Despacho (nf) no encontrada!
A ND no foi encontrada, atravs do nmero do Documento Fiscal, para a Conta
Corrente informada.
pontualcargas/ws/nd/getByNF - 12
Onde:
# Campo Ele Pai Tipo Descrio
AR01 getResponse Raiz - - TAG raiz
AR02 nd E AR01 nd Estrutura de dados da Nota de Despacho
AR03 apolicesegproprio E AR02 string Se o Cliente possui aplice de seguro
prpria ou no:
S ou N
AR04 codcliente E AR02 long Cdigo do Cliente junto Pontual (Conta
Corrente)
AR05 coleta E AR02 boolean Se foi utilizado servio de Coleta:
S ou N
AR06 coletadatahora E AR02 dateTime Data e hora em que a carga foi coletada:
DD-MM-YYYYTHH:MM:SS[TIME_ZONE]
AR07 coletador E AR02 string Nome do funcionrio da Pontual que efetuou
a coleta da carga
AR08 confirmacaodatahora E AR02 dateTime Data e hora em que a carga foi entregue ao
destinatrio:
DD-MM-YYYYTHH:MM:SS[TIME_ZONE]
AR09 confirmacaonome E AR02 string Nome de quem recebeu a carga no destino
AR10 confirmacaorg E AR02 string Nmero do documento de quem recebeu a
carga no destino
AR11 conteudo E AR02 string Descrio do contedo dos volumes da
carga
AR12 datahora E AR02 dateTime Data e hora que a ND foi emitida:
DD-MM-YYYYTHH:MM:SS[TIME_ZONE]
AR13 destinatario E AR02 endereco Detalhes do Destinatrio
AR14 bairro E AR13 string Bairro do endereo
AR15 cep E AR13 int CEP do endereo
AR16 cnpj E AR13 string CNPJ, se Pessoa Jurdica
AR17 cpf E AR13 string CPF, se Pessoa Fsica
AR18 fax E AR13 string Nmero do FAX
AR19 fone E AR13 string Nmero do Telefone
AR20 ie E AR13 string Nmero de Inscrio Estadual, se
Pessoa Jurdica
AR21 logradouro E AR13 string Endereo
AR22 nome E AR13 string Nome
AR23 destino E AR02 localidade Detalhes da cidade de Destino
AR24 estado E AR23 string Nome da Unidade Federativa
AR25 id E AR23 long Nmero da Cidade (cdigo interno da
Pontual)
AR26 name E AR23 string Nome da Cidade
AR27 siglaLocalidade E AR23 string Sigla da Localidade
AR28 uf E AR23 string Sigla da Unidade Federativa
AR29 dimensoes E AR02 string Detalhes das dimenses dos volumes da
carga
AR30 emergencia E AR02 boolean Se foi utilizado servio de Emergncia:
S ou N
AR31 entrega E AR02 boolean Se foi utilizado servio de Entrega:
S ou N
AR32 especie E AR02 string Descrio da espcie da carga
AR33 id E AR02 long Nmero da Nota de Despacho
AR34 nomecliente E AR02 string Nome do Cliente (Conta Corrente)
AR35 notafiscal E AR02 string Detalhes de documentos fiscais relativos
carga
AR36 obs E AR02 string Observaes diversas sobre a ND
AR37 origem E AR02 localidade Detalhes da cidade de Origem
AR38 estado E AR37 string Nome da Unidade Federativa
AR39 id E AR37 long Nmero da Cidade (cdigo interno da
Pontual)
AR40 name E AR37 string Nome da Cidade
AR41 siglaLocalidade E AR37 string Sigla da Localidade
pontualcargas/ws/nd/getByNF - 14
pontualcargas/servicos/ws/nd/trackingByND
Consultar os detalhes de Rastreamento de uma Nota de Despacho no banco de dados
da empresa atravs do nmero da mesma.
1. Endereo
http://www.pontualcargas.com.br/servicos/ws/nd/trackingByND
Exemplo:
<?xml version="1.0"?>
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:q0="http://www.pontualcargas.com/servicos/ws/nd">
<soapenv:Header/>
<soapenv:Body>
<q0:trackingByND>
<login>
<password>********</password>
<username>100</username>
</login>
<nd>5773882</nd>
</q0:trackingByND>
</soapenv:Body>
</soapenv:Envelope>
Onde:
faultcode faultstring
soap:Server Usurio ou senha incorreta!
Verifique os dados de login (usurio e senha).
soap:Server Nota de Despacho (nd) no encontrada!
A ND no foi encontrada, atravs do nmero do Documento Fiscal, para a Conta
Corrente informada.
pontualcargas/ws/nd/trackingByND - 16
Onde:
# Campo Ele Pai Tipo Descrio
AR01 trackingByND Raiz - - TAG raiz
AR02 rastreamento E AR01 rastramento Estrutura de dados de detalhes do
Rastreamento de uma Nota de
Despacho
AR03 confirmacaodatahora E AR02 dateTime Data e hora em que a carga foi
entregue ao destinatrio:
DD-MM-
YYYYTHH:MM:SS[TIME_ZONE]
AR04 confirmacaonome E AR02 string Nome de quem recebeu a carga
no destino
AR05 confirmacaorg E AR02 string Nmero do documento de quem
recebeu a carga no destino
AR06 notafiscal E AR02 string Detalhes de documentos fiscais
relativos carga
AR07 nrnd E AR02 long Nmero da Nota de Despacho
AR08 detalhes E AR02 rastreamentoDetalhe Detalhes de cada passo do
Rastreamento.
Esta chave se repete para cada
passo de rastreamento da carga.
AR09 datahora E AR08 dateTime Data e hora de ocorrncia
YYYYTHH:MM:SS[TIME_ZONE]
AR10 evento E AR08 int Cdigo do Evento (cdigo
interno da Pontual)
Veja Tabela 2
AR11 obs E AR08 string Observaes diversas sobre
este passo
AR12 ocorrncia E AR08 string Descrio deste passo
AR13 previsaodatahora E AR02 dateTime Data e Hora de previso de
entrega da carga, baseado em
contrato e na data e hora de coleta
da carga:
DD-MM-
YYYYTHH:MM:SS[TIME_ZONE]
AR14 status E AR02 int Situao atual da carga (cdigo
interno da Pontual)
Veja Tabela 1
pontualcargas/ws/nd/trackingByNF - 18
pontualcargas/servicos/ws/nd/trackingByNF
Consultar os detalhes de Rastreamento de uma Nota de Despacho no banco de dados
da empresa atravs do nmero do Documento Fiscal da mesma.
1. Endereo
http://www.pontualcargas.com.br/servicos/ws/nd/trackingByNF
Exemplo:
<?xml version="1.0"?>
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:q0="http://www.pontualcargas.com/servicos/ws/nd">
<soapenv:Header/>
<soapenv:Body>
<q0:trackingByNF>
<login>
<password>********</password>
<username>100</username>
</login>
<nf>9310</nf>
</q0:trackingByNF>
</soapenv:Body>
</soapenv:Envelope>
Onde:
faultcode faultstring
soap:Server Usurio ou senha incorreta!
Verifique os dados de login (usurio e senha).
soap:Server Nota de Despacho (nf) no encontrada!
A ND no foi encontrada, atravs do nmero do Documento Fiscal, para a Conta
Corrente informada.
pontualcargas/ws/nd/trackingByNF - 19
Onde:
# Campo Ele Pai Tipo Descrio
AR01 trackingByNF Raiz - - TAG raiz
AR02 rastreamento E AR01 rastramento Estrutura de dados de detalhes do
Rastreamento de uma Nota de
Despacho
AR03 confirmacaodatahora E AR02 dateTime Data e hora em que a carga foi
entregue ao destinatrio:
DD-MM-
YYYYTHH:MM:SS[TIME_ZONE]
AR04 confirmacaonome E AR02 string Nome de quem recebeu a carga
no destino
AR05 confirmacaorg E AR02 string Nmero do documento de quem
recebeu a carga no destino
AR06 notafiscal E AR02 string Detalhes de documentos fiscais
relativos carga
AR07 nrnd E AR02 long Nmero da Nota de Despacho
AR08 detalhes E AR02 rastreamentoDetalhe Detalhes de cada passo do
Rastreamento.
Esta chave se repete para cada
passo de rastreamento da carga.
AR09 datahora E AR08 dateTime Data e hora de ocorrncia
YYYYTHH:MM:SS[TIME_ZONE]
AR10 evento E AR08 int Cdigo do Evento (cdigo
interno da Pontual)
Veja Tabela 2
AR11 obs E AR08 string Observaes diversas sobre
este passo
AR12 ocorrncia E AR08 string Descrio deste passo
AR13 previsaodatahora E AR02 dateTime Data e Hora de previso de
entrega da carga, baseado em
contrato e na data e hora de coleta
da carga:
DD-MM-
YYYYTHH:MM:SS[TIME_ZONE]
AR14 status E AR02 int Situao atual da carga (cdigo
interno da Pontual)
Veja Tabela 1
Exemplos de utilizao - 21
Cdigo Descrio
1 Includa
2 Emitida
3 Coletada
4 Despachada
5 Retirada
6 Despachada (Trecho 2)
7 Retirada (Trecho 2)
8 Sada p/Entrega
9 Entregue
98 Cancelada
99 Outros
Cdigo Descrio
10 Manifestado em: <origem>/<uf>
20 Embarque na Cia para: <destino>/<uf>
30 Retirada da Cia em: <destino>/<uf>
40 Embarque na Cia para: <destino>/<uf> (Trecho 2)
50 Retirada da Cia em: <destino>/<uf> (Trecho 2)
60 Sada para Entrega
70 Entregue ao Destinatrio <nome> - Doc: <documento>
... Outros