Manual Webservice Finnet

Transcrição

1 Página 1 de 9

2 ÍNDICE Introdução Objetivo do Documento Solução Características da Solução Procedimento de Homologação da API Códigos de Erros Contatos Página 2 de 9

3 1. Introdução 1.1. Objetivo do Documento Esse documento tem a finalidade de apresentar o produto Webservice da Finnet. 2. Solução 2.1. Características da Solução O Webservice da Finnet permite realizar o envio de arquivos entre o cliente e a Finnet de forma automática, segura e otimizada. O Websevice utiliza o protocolo SOAP para oferecer uma série de funções que permitem realizar a transmissão e recepção dos arquivos. O tamanho máximo para os arquivos enviados é de 50 Mb. A execução do método ConfirmarArquivos retira o arquivo da lista de arquivos pendentes para envio, mas mantém uma cópia em backup. O cliente realiza uma integração padrão com o webservice na linguagem de programação que achar conveniente Endereços e funcionalidade O Webservice da Finnet está disponível no endereço edi.finnet.com.br O documento WSDL pode ser obtido em edi.finnet.com.br/index.php?wsdl Para fins de desenvolvimento e testes está disponível o ambiente de homologação no endereço Página 3 de 9

4 com o documento WSDL em Um usuário válido será fornecido para o ambiente de testes antes de realizar os testes de integração. Após a homologação (ver procedimento na seção Procedimento de Homologação ), um usuário válido para o ambiente de produção e a integração pode ser liberada. Os métodos disponíveis no webservice são: EnviarArquivosRequest EnviarArquivos ListarArquivos ReceberArquivos ConfirmarArquivos A descrição detalhada de cada um está na seção da API. 3. Procedimento de Homologação Para realizar a homologação será necessário ter o ambiente de integração disponível. As operações de homologação devem confirmar que cada um dos métodos do Webservice está funcionando corretamente nas diferentes variantes de comunicação. Lista de passos de homologação 1. Testar o método EnviarArquivosRequest 2. Testar o método EnviarArquivos 3. Testar o método ListarArquivos 4. Testar o método ReceberArquivos Página 4 de 9

5 5. Testar o método ConfirmarArquivos Para completar a homologação da função ReceberArquivos a Finnet disponibilizará arquivos de teste na caixa postal do cliente para realizar o download. 4. da API Métodos Transfer.ListarArquivos Este método irá listar todos os arquivos disponíveis para download na caixa postal do cliente. Parâmetros usuario: string senha: string caixa_postal: string encode: string Retorno Este método irá retornar uma string com a lista de arquivos, separados por um caractere de quebra de linha (\n) ou uma mensagem de erro para o caso não consiga listar os arquivos. Para ter o retorno em UTF 8, deve se passar o valor do parâmetro encode como utf8. Transfer.ReceberArquivos Este método serve para realizar o download do arquivo codificado usando base64. Parâmetros usuario: string senha: string caixa_postal: string Página 5 de 9

6 filename: string encode: string Retorno Este método irá retornar o conteúdo do arquivo codificado usando base64 ou uma mensagem de erro para o caso de não conseguir manipular o arquivo. Para ter o retorno em UTF 8, deve se passar o valor do parâmetro encode como utf8. Transfer.EnviarArquivos Este método serve para efetuar o upload do arquivo. O conteúdo a ser enviado deverá ser codificado com base64. O parâmetro hash deverá ser um MD5 do arquivo. Parâmetros usuario: string senha: string caixa_postal: string hash: string filename: string conteudo: string encode: string Retorno Este método irá retornar uma mensagem informativa ou de erro de acordo com o status do envio do arquivo. Para ter o retorno em UTF 8, deve se passar o valor do parâmetro encode como utf8. Um exemplo, o texto original: MEUTESTE e para o serviço devem ser enviado o conteúdo TUVVVEVTVEU= e o hash 3a7c403a848f2f2fc0e59c44203f2cd8 Página 6 de 9

7 Transfer.EnviarArquivosRequest Este método é similar so método Transfer.EnviarArquivos. Transfer.ConfirmarArquivos Este método serve para confirmar o recebimento do arquivo após seu download. Parâmetros usuario: string senha: string caixa_postal: string filename: string encode: string Retorno Este método retorna uma mensagem informativa ou de erro de acordo com o status da confirmação do arquivo. Para ter o retorno em UTF 8, deve se passar o valor do parâmetro encode como utf8. 5. Códigos de Erros Os códigos de erro retornados: Arquivo nao informado Parâmetro do nome do arquivo vazio Arquivo nao encontrado. Arquivo para download não encontrado Página 7 de 9

8 Usuario/Senha/cx_postal não conferem Hash nao informado Hash do arquivo para envio não foi informado Arquivo nao pode ser vazio Conteúdo do arquivo para envio vazio O arquivo é maior que 50mb Limite de 50Mb para envío excedido Hash do conteudo nao confere Hash do arquivo não confere com o hash enviado COD:5001 Entre em contato URGENTE com nosso suporte ( ) para confirmar o envio do arquivo Erro COD: ) Nao foi possivel enviar o arquivo. Entre em contato com nosso suporte (11 6. Contatos Página 8 de 9

9 Produção Adilson Padua Infra Caio Camargo Página 9 de 9