sistema pamcard -contrato de frete - especificacao ... pamcard -contrato de frete... ·...

Download Sistema Pamcard -Contrato de Frete - Especificacao ... Pamcard -Contrato de Frete... · Confidencial…

Post on 07-Nov-2018

213 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

  • Sistema Pamcard - Contrato de Frete

    Especificao de Integrao Verso 1.0

  • Confidencial Pg. 2 de 51

    Histrico das Revises

    Data Verso Descrio Autor

    09/09/2011 1.0 Verso Inicial Miriam Alborghetti

    09/09/2011 1.1 Ajustes Tabelas e descries Miriam Alborghetti

  • Confidencial Pg. 3 de 51

    1 Introduo 5

    2 Definies e Abreviaes 5

    3 Requisitos 5

    3.1 Requisitos Tcnicos 5 3.2 Requisitos de Segurana / Confiabilidade 5 3.3 Requisitos de Comunicao 6

    4 Arquitetura 6

    5 Opes de Integrao 7

    5.1 WebService 7 5.2 Adaptador 7 5.3 Arquivo de Retorno para Download 8

    6 Funcionalidades 8

    6.1 Incluir Contrato Frete 8 6.2 Consultar Viagem 12 6.3 Consultar Status da Parcela 17 6.4 Alterar Status da Parcela 18 6.5 Consultar Status do Pedgio 19 6.6 Alterar Status do Pedgio 20 6.7 Roteirizar 21 6.8 Consultar Carto 23 6.9 Inserir Parcela 24 6.10 Incluir Carto Portador Frete 25 6.11 Incluir Favorecido 26 6.12 Consultar Favorecido 27 6.13 Incluir Conta 28 6.14 Consultar Conta 29

    7 Apndices 30

    7.1 WSDL 30 7.2 Adaptador 32

    7.2.1 Instalao 32 7.2.2 Estrutura de Diretrios (verso windows) 32 7.2.3 Gerao do Arquivo 34 7.2.4 Configurao 34 7.2.5 Adaptador Exemplos 38 3 - Incluso Contrato de Frete: 38 6 - Consultar viagem 41 8 - Consuta Status da Parcela 42 9 - Consultar Status do Pedgio 43 10 - Roteirizao de Viagem 43 11 - Consulta Carto 44 13 - Atualizar Status do Pedgio 44 14 - Alterao de Status de Parcela 45 16- Incluso de Carto Portador Frete 45

    7.3 Tabelas 46 Tipo de Documento da Viagem 46 Tipo do Carto 46 Tipo de Documento 46 Tipo da Parcela 47 Tipo de Efetivao 47 Tipo de Origem 47 Tipos Documento Complementar 47

  • Confidencial Pg. 4 de 51

    Status da Parcela 48 Status do Pedgio 48 Status da Viagem 48 Tipo de Transacao 48 Status do Carto Pamcard 48 Status da Transao 48 Status da Conta do Favorecido 48 Categorias do Veculo 48 Cdigos e Mensagens de Retorno 49

    7.4 Referncias 50 7.5 Lay-Out Arquivo de Transaes (Download) 51

  • Confidencial Pg. 5 de 51

    1 Introduo

    Este documento destinado a profissionais da rea de TI e tem como objetivo detalhar as formas para realizar a integrao com o Sistema Pamcard Contrato de Frete. O Sistema Pamcard tem como objetivo agilizar o processo de pagamentos de pedgios, fretes, dirias e combustveis aos caminhoneiros fornecendo de forma eficaz um meio eletrnico e seguro para as empresas que realizam transportes rodovirio de cargas.

    2 Definies e Abreviaes

    HTTPS: Hipertext Transfer Protocol Secure IDE: Integrated Development Environment RPC: Remote Procedure Call SOAP: Simple Object Access Protocol SSL: Secure Socket Layer WSDL: Web Service Definition Language XML: Extend Markup Language

    BIN: Bank Identification Number (So os 6 primeiros nmeros do Carto VISA) BBBB BB99 9999 9999

    3 Requisitos

    3.1 Requisitos Tcnicos

    Para a utilizao do mdulo de integrao do sistema Pamcard o computador a ser utilizado dever possuir:

    o Windows acima de 2000 o Acesso liberado para a internet o Java Virtual Machine instalado (qualquer verso acima de jre-1_5)

    Caso necessrio o Java Virtual Machine poder ser baixado atravs do site www.java.com, sem custo de licenciamento.

    3.2 Requisitos de Segurana / Confiabilidade O acesso s funcionalidades disponibilizadas pelo Web Service Pamcard deve ser feito atravs de um certificado digital, que garante segurana na autenticao de usurios do sistema. O certificado contm a identificao da empresa (CNPJ) e gerado para o cliente pela Pamcary. O Web Service Pamcard validar o certificado enviado pelo cliente.

  • Confidencial Pg. 6 de 51

    3.3 Requisitos de Comunicao

    A comunicao entre clientes e servidores ser feita atravs do SOAP (Simple Object Access Protocol). Esse protocolo definido em XML, sendo assim, as chamadas a procedimentos remotos (RPC) so codificadas em XML. Para transporte das mensagens ser usado o HTTPS. O acesso ao servidor que hospeda Web Service Pamcard se dar por acesso internet. O cliente dever possuir um certificado de autenticao no servidor e um usurio no Sistema Pamcard com perfil especfico para realizar as transaes. Este usurio somente poder ser utilizado nestas transaes, no sendo permitido a este usurio acessar o sistema na Web.

    4 Arquitetura

  • Confidencial Pg. 7 de 51

    5 Opes de Integrao

    5.1 WebService

    Este modelo de integrao foi desenvolvido especialmente para se integrar aos sistemas dos nossos clientes, visando a disponibilizao da informao em tempo real, eliminando retrabalho e permitindo um processo de uso fcil pelos operadores.

    Todo web services descrito atravs de um documento WSDL (Web Service Definition Language) que descreve todos os servios, seus parmetros de entrada e sada, e at mesmo a estrutura de dados destes parmetros, caso esta seja complexa. O documento WSDL deve ser utilizado pelos desenvolvedores das aplicaes que consomem os web services para a gerao do cliente de comunicao atravs de uma IDE apropriada. Uma IDE ir produzir cdigo que implemente a comunicao de rede para invocao dos servios. A estrutura do WSPamcard.wsdl est disponvel no apndice deste documento

    5.2 Adaptador A comunicao entre o Sistema do Cliente e o Web Service Pamcard se dar atravs de um componente Adaptador, por meio de arquivos, ou seja, para cada funcionalidade disponvel no Web Service Pamcard haver um arquivo texto parametrizado correspondente com os dados de entrada e, aps o processamento, ser retornado um arquivo texto parametrizado de mesmo nome do arquivo de entrada com o contedo de resposta solicitao.

    Para mais detalhes da instalao, configurao e utilizao deste mdulo, veja as instrues do Adaptador no apndice deste documento.

  • Confidencial Pg. 8 de 51

    5.3 Arquivo de Retorno para Download

    Este arquivo gerado diariamente contendo as transaes efetivadas do dia anterior e disponibilizado para download atravs do Site do Sistema Pamcard. O layout deste arquivo est detalhado no apndice deste documento.

    6 Funcionalidades

    O Sistema Pamcard permite realizar as seguintes transaes via integrao:

    Operao Funo Cdigo

    Consulta de Viagem FindTrip 5

    Consulta Status de Parcela FindParcelStatus 7

    Atualizar Status de Parcela UpdateParcelStatus 8

    Consultar Status do Pedgio FindTollStatus 9

    Atualizar Status do Pedgio UpdateTollStatus 10

    Roteirizao Router 11

    Consulta de Carto FindCard 12 Incluir Carto Portador Frete InsertCardFreight 21 Consultar Favorecido FindFavored 22 Inserir Favorecido InsertFavored 23 Consultar Conta Favorecido FindFavoredAccount 24 Inserir Conta Favorecido InsertFavoredAccount 25 Inserir Contrato Frete Insert 26

    A tabela acima especifica as operaes, as funes disponibilizadas no Web Service e respectivos cdigos de operaes do Adaptador.

    6.1 Incluir Contrato Frete

    Operao que permite a incluso de uma viagem no Sistema Pamcard. Abaixo segue a definio dos parmetros de entrada e os campos de entrada e sada:

    Campos de Entrada

    VIAGEM

    Descrio Tipo Tam Observao

    1 viagem.contratante.documento.numero alfanumrico 20 Obrigatrio

    2 viagem.unidade.documento.tipo numrico 2 Fixo=1-CNPJ

    3 viagem.unidade.documento.numero alfanumrico 20

    4 viagem.id.cliente numrico Obs.1

    5 viagem.contrato.numero alfanumrico Obrigatrio

    6 Viagem.favorecidoN.tipo Numrico 1 1-Contratado 2-subContratante

    7 Viagem. favorecidoN.documento.tipo numrico 2 obrigatorio 1-CNPJ ou 2-CPF

    8 Viagem. favorecidoN.documento.numero alfanumrico 30 Obrigatrio Obs.3

  • Confidencial Pg. 9 de 51

    9 Viagem. favorecidoN.meio.pagamento numrico 1 1=carto; 2=conta depsito

    10 Viagem. favorecidoN.conta.banco Numrico 4 Obs. 2

    11 Viagem. favorecidoN.conta.agencia alfanumrico 10 Obs. 2

    12 Viagem. favorecidoN.conta.numero Alfanumrico 10 Obs. 2

    13 Viagem. favorecidoN.conta.tipo Numrico 1 Obs. 2

    14 viagem. favorecidoN.cartao.numero numrico 16 Obs.4

    15 Viagem.veiculo.placa.qtde Numrico 1 Max. 5 ocorrncias

    16 viagem.veiculo.placaN Alfanumrico 7 Obrigatrio Obs 5

    17 viagem.veiculo.rntrcN alfanumrico 7

    18 viagem.veiculo.categoria Alfanumrico Obrigatrio se viagem.pedagio.roteirizar=S

    19 viagem.data.partida Data 10 dd/mm/yyyy

    20 viagem.data.termino Data 10 dd/mm/yyyy Obs 6

    21 viagem.rota.id numrico 10 Obs 7

    22 viagem.rota.nome alfanumrico 50 Obs 9

    23 viagem.origem.pais.nome alfanumrico 50 Obs 10

    24 viagem.origem.estado.nome alfanumrico 50 Obs 10

    25 viagem.origem.cidade.nome alfanumrico 50 Obs 10

    26 viagem.origem.cidade.ibge numrico 7 Obs 10

    27 viagem.destino.cidade.ibge numerico 7 Obs 10

    28 viagem.destino.pais.nome alfanumrico 50 Obs 10

    29 viagem.destino.estado.nome alfanumrico 50 Obs 10

    30 viagem.destino.cidade.nome alfanumrico 50 Obs 10

    31 viagem.ponto.qtde numrico 10 Obs 11

    31.1 viagem.pontoN.pais.nome alfanumrico 50

    31.2 viagem.pontoN.estado.nome alfanumrico 50

    31.3 viagem.pontoN.cidade.nome alfanumrico 50

    31.4 viagem.pontoN.cidade.ibge numrico 7

    32 viagem.pedagio.valor decimal 9,2 Obs 12

    33 viagem.pedagio.status.id numrico 2 Ver Tabela

    34 viagem.pedagio.roteirizar booleano 1 (S ou N) Obs 13

    35 viagem.pedagio.obter.praca Alfa 1 (S ou N) Obs 14

    36 viagem.pedagio.utiliza.saldo Alfa 1 (S ou N) obs 15

    37 Viagem.carga.tipo Numrico 1 1-Lotao 2-Fracionada

    38 viagem.documento.qtde numrico 10 Obrigatrio Obs. 16

    39 viagem.documentoN.tipo numrico 2 Obrigatrio Ver Tabe