Webservice ACOM Sistemas (Modelo JSON)

Visão Geral

Esse documento visa descrever os métodos da API de webservice da ACOM SISTEMAS.

1.0 Método de Envio de Arquivo de Vendas

Este método envia o arquivo de vendas codificado em base64 para geração das informações de estoque.

Método EnviarArquivoVendas

1.1 Parâmetros:

  • Endereço IP: Fornecido pela ACOM, exemplo: http://integra.acom.net.br:8087;
  • Diretório Virtual: Fornecido pela ACOM, exemplo: /AcomIntegracao/AcomRestServer.dll/DataSnap/Rest/TsmIntegracaoArquivo/ ;
  • Método de Integração: Fornecido pela ACOM, exemplo: EnviarArquivoVendas ;
  • Token (String): Fornecido pela Acom, exemplo: VJC90008765 ;
  • CNPJ (String): Deve conter 14 caracteres sem formatação, exemplo 00019357000383;
  • Data de movimento (String): Deve-se passar uma data no formato YYYY-MM-DD, exemplo: 2016-10-17;
  • Nome do arquivo (String): Deve conter sua extensão junto ao nome do arquivo, exemplo: txt;
  • Arquivo (Objeto JSON): Passar um objeto JSON onde o conteúdo do arquivo deve estar convertido em base64(charset UTF-8).
    Este objeto deve conter um único par no seguinte padrão:
    {“arquivo”:Conteúdo do arquivo convertido em Base64”}

 

 

2.0 Método de Envio de Arquivo Financeiro

Este método envia o arquivo financeiro (Conciliação Financeira) codificado em base64, para a geração das informações de recebíveis.

Método EnviarArquivoFinanceiro

2.1 Os parâmetros utilizados são os mesmos do Método de Envio de Arquivo de Vendas (tópico 1.1)

3.0 Códigos de Mensagens

3.1 Após consumir nossa API, são retornados os erros abaixo, que devem ser tratados conforme a necessidade.

  • a. Mensagens genéricas ou de exceções.
    Ação: Informe a ACOM.
  • b. Arquivo integrado com sucesso.
    Ação: Visualizar o arquivo no MLO.
  • c. Token inválido.
    Ação: Verifique o TOKEN utilizado.
  • d. CNPJ inválido ou não licenciado.
    Ação: Verifique se o CNPJ está no formato correto e se esta licenciado para integração com a ACOM.
  • e. Data de movimento inválida. A data deve estar no padrão YYYY-MM-DD.
    Ação: Verifique se o formato da data está correto.
  • f. Nome do arquivo não informado.
    Ação: Informe o nome do arquivo como parâmetro.
  • g. Arquivo não possui extensão em seu nome.
    Ação: Informe a extensão do arquivo após o nome.
  • h. Arquivo %s já importado.
    Ação: Arquivo já integrado não é necessário o reenvio.
  • i. Objeto JSON que corresponde ao arquivo é inválido.
    Ação: Verifique a formatação e o conteúdo convertido em base64.
  • j. Arquivo vazio.
    Ação: Verificar o conteúdo do arquivo.
  • k. Arquivo não pertence ao CNPJ informado.
    Ação: Verificar se o CNPJ do arquivo convertido em base64 é do mesmo CNPJ que está sendo usado nos parâmetros.

4.0 Conversão em Base64

Os arquivos devem obrigatoriamente estarem convertidos em base64, conforme: https://www.base64decode.org/

5.0 Ferramenta para Teste de Integração

Para testar o consumo de nossa API sugerimos o uso da ferramenta POSTMAN.

Instalação: link

Configuração:  

5.1-Método de execução: PUT
5.2
– Request URL: http://xn--endereoip-v3a/Nome_diretorio_virtual/AcomRestServer.dll/DataSnap/Rest/TsmIntegracaoArquivo/EnviarArquivoVendas/token/cnpj/data_de_movimento/nome_arquivo.extensao 
5.3
– Marcar a opção: Body5
5.4– Marcar a opção: RAW
5.5
Escolher a opção: JSON (application/json)
5.6
 
No campo de texto informar o objeto JSON: {“arquivo”: “Conteúdo do arquivo convertido em Base64”}
*Clicar no SEND (para verificar o retorno seguir os passos abaixo)*
5.7
– Marcar a opção: Body
5.8
– Marcar a opção: Pretty
5.9
– Escolher a opção: JSON
5.10- 
Campo que mostra o resultado, sendo composto do código e mensagem:
Ação: Verificar se o CNPJ do arquivo convertido em base64 é do mesmo CNPJ que está sendo usado nos parâmetros.

Exemplo de mensagem de retorno:
print

 

Tags