Considerações Iniciais
Este
manual tem como objetivo propiciar o Sistema de Automação Comercial a
consultar diretamente nossa base de informações utilizando os serviços
disponíveis no site através de Web services.
Por questões de segurança quando uma consulta é efetuada o número IP do
solicitante é armazenado. O mesmo usuário somente poderá consultar novamente
com um IP diferente 20 minutos após a primeira consulta. Portanto não é
recomendável esta aplicação para usuários de internet com conexão discada ou
que conecte a internet a cada consulta, pois nestes casos recebe um IP
diferente a cada conexão.
Para testes deverá ser passado em todos os parâmetros o valor 1, o valor do
parâmetro documento deverá ser 1 para respostas sem restrições e 2 para
respostas com restrições, o valor do parâmetro formato da resposta pode
ser qualquer valor da tabela abaixo. É obrigatório o envio todos os parâmetros preenchidos,
menos para o campo CMC7 que é opcional.
Descrição dos serviços
O endereço http://www.federalweb.com.br/webservice.asmx?WSDL contém a descrição de todos os serviços que devem ser consumidos passando os parâmetros detalhados abaixo conforme cada serviço.
Consulta
Informações sobre cheque CCF BACEN, SCPC, SERASA e demais entidades dependendo do parâmetro informado ou da configuração específica de cada cliente, por exemplo, definir que cheques com valor acima de um montante, mesmo sendo solicitada pela aplicação a consulta CCF BACEN seja também consultado SCPC e adicionado na resposta. Outras consultas podem ser inseridas sem aviso prévio.
|
Parâmetro |
Tipo |
|
|
Código do Cliente |
String |
Código do cliente no cadastro da FederalWeb. |
|
Código do Usuário |
Inteiro |
|
|
Senha do Usuário |
String |
|
|
Documento |
String |
|
|
Data do Cheque |
DateTime |
|
|
Valor |
Double |
|
|
CMC7 |
String |
CMC7 do cheque somente os
números, sem nenhuma formatação. |
|
Código da Consulta |
Inteiro |
1 - CCF / BACEN 2 - Integrada |
|
Formato da Resposta |
Inteiro |
1 - Texto puro sem detalhes sem formatação. 2 - Texto puro com detalhes sem formatação. 3 - Formatado HTML. |
|
Dispositivo |
Inteiro |
|
|
Código do Integrador |
Inteiro |
|
Respostas
Todas as respostas são devolvidas em uma String formatada conforme descrição abaixo.
|
Inicial |
Final |
bytes |
Descrição |
|
1 |
10 |
10 |
Protocolo Deve ser armazenado no sistema ou escrito no cheque para futuras consultas. |
|
11 |
11 |
1 |
Resultado da Consulta 0 - Nada consta. 1 - Nada consta com passagem. 2 - Constam informações. 3 - Constam informações no cadastro interno. 9 - Erro na consulta. |
|
12 |
14 |
4 |
Tamanho do Texto de Resposta Contém o total de bytes da posição final |
|
16 |
* |
* |
Texto de Resposta Seu tamanho é variável e contém o resultado textual da consulta |
O que é Web services
É uma solução utilizada na integração de sistemas e na comunicação entre aplicações diferentes. Com esta tecnologia é possível que novas aplicações possam interagir com aquelas que já existem e que sistemas desenvolvidos em plataformas diferentes sejam compatíveis.
Muitos consideram que os Web services corrigem um grande problema da informática, a falta de integração de sistemas. Os Web services permitem que a integração de sistemas seja realizada de maneira compreensível, reutilizável e padronizada. É uma tentativa de organizar um cenário cercado por uma grande variedade de diferentes aplicativos, fornecedores e plataformas.
Quais as tecnologias envolvidas
As bases para a construção de um Web Service são os padrões XML (eXtensible Markup Language) e SOAP (Simple Object Access Protocol). O transporte dos dados é realizado normalmente via protocolo HTTP ou HTTPS para conexões seguras (o padrão não determina o protocolo de transporte). Os dados são transferidos no formato XML, encapsulados pelo protocolo SOAP. Os serviços disponíveis são descritos usando a linguagem WSDL (Web Services Description Language).
Entendi tudo e agora como eu faço ?
Para quem não quer nem pesquisar no Google como fazer, segue exemplos em algumas linguagens.
Os exemplos estão focados na idéia básica do recurso, não esta sendo levada em consideração a inclusão de blocos protegidos, boas práticas de cada linguagem, isto cabe a cada desenvolvedor implementar em seu código.
As
linguagens mais novas e outras mais antigas que tenham capacidade de acessar um
objeto COM em Windows 32 conseguem de alguma forma consumir Web services.
Exemplo em Delphi usando componente SOAP
Os exemplos abaixo estão fazendo referência a um objeto COM e irão funcionar em qualquer cliente com .NET Framework instalado, caso o cliente não tenha .NET Framework instalado ou pior ainda, use Windows 98/ME/NT4 a maneira mais fácil de implementar é usando o SOAP Toolkit.
Não conhece o Soap Toolkit então clique aqui
Sempre que o .NET Framework estiver instalado a referência ao objeto será MSSOAPLib.SoapClient, no caso do SOAP Toolkit 3.0 então a referência ao objeto deverá ser MSSOAPLib30.SoapClient30 em todos os exemplos abaixo. Estamos usando "Late Binding" para fazer referência ao objeto, porém, normalmente é preferível carregar a "Type Library" e chamar o objeto COM usando "Early Binding".
Exemplo em Visual Basic 6 usando MSSOAPLib
Exemplo em Delphi usando a MSSOAPLib
Considerações Finais
Este material foi desenvolvido com o intuito de sanar as necessidades existentes até o momento, dúvidas, sugestões ou comentários que venham contribuir para o enriquecimento deste material será bem vinda através do contato suporte@federalweb.com.br