Sumário

1 Conceito

O AS Integrador é um meio de integração, exportação e consulta SQL, com o intuito de compartilhar dados da base AutoSystem com fontes externas, como por exemplo sistemas de terceiros.


2 Requisitos

Para a utilização do AS Integrador é necessário possuir os seguintes requisitos:

  • Estar com o módulo "AS Integrador" liberado na chave;
  • Porta 5482 disponível para rodar o serviço --as_integrador.

3 Configurações

Para utilizar a rotina do AS Integrador será necessário configurar as Permissões de Acesso dos usuários no módulo Gerencial. Estas configurações serão descritas abaixo:


3.1 Permissões de Acesso

No módulo Gerencial, acessar o menu Configurações  > Usuários > Grupos de Usuários e ativar a permissão Integrações customizadas através do módulo AS integrador de um grupo:



4 Funcionalidades

O AS Integrador pode ser acessado no módulo Gerencial, menu Configuração > Módulos > AS Integrador > Gerenciador de Integrações.



Clicar no botão Novo para adicionar um registro. Inserir o Nome da Integração e o SQL a ser executado. Cabe ressaltar que o nome não pode conter espaço, caracteres especiais nem letras maiúsculas.



Importante:

Uso dos placeHolder na construção do SQL:

  • Placeholders Disponíveis:

    • %(selecao)s - WHERE clause (o sistema adiciona "WHERE " automaticamente)

    • %(projecao)s - campos do SELECT (padrão: "*")

    • %(condicao)s - condições adicionais (sem "WHERE" automático)

    • %(campos)s - campos do INSERT

    • %(valores)s - valores do INSERT

    • %(expressao)s - expressões do UPDATE

 



  • Uso de paginação:
    • Agora é possível passar um limit dentro da requisição da API. Isso garante que SQL muito grandes podem retornar um número máximo de registros,  impedindo de demorar mais que 30 segundos e estourando timout
    • Exemplo de como enviar essas informações dentro da requisição:
    • A paginação precisa ser "true" e e precisa do limit, requisição start sempre page 1 ou sem a tag, as demais precisam vir com tag page = nextPage da requisição anterior:
    • A ser enviado na requisição:
    • {
        "cnpj": "xxxxxxxxxxx", #CNPJ do Posto
        "chave": "52e612df5ddfb3d9bad104b3dfac4477", #Chave de acesso gerada
        "paginacao": true, # Usar novo método de paginação
        "page": 2, # Página a ser consultada
        "limit": 500, # Limite por página
        "selecao": "nf.data_emissao BETWEEN '2025-12-15' AND '2025-12-15'" # Condição Where do SQL
      }
    • O que retorna:
      • page: Página Atual da Consulta
        limit: Limite Utilizado na consulta
        totalRecords: Total de registros sem paginação
        totalPages: Total de Páginas disponíveis
        nextPage: Próxima Página a ser consultada
        previousPage: Página anterior a ser consultada
        returnedCount: Total de registros retornados na página

 





Após inserir as informações clicar em Salvar.



Clicar no botão Chave e gerar a chave de segurança para acesso ao sistema de terceiro.



Em seguida clicar no botão Salvar.


5 Criação de Atalho

Para que seja possível a troca de informações entre o AutoSystem e o sistema de terceiro, é necessário criar um atalho a partir do módulo Gerencial (main.exe) e acrescentar o parâmetro --as_integrador, como mostra a imagem abaixo:



Para ativá-lo, basta dar um duplo clique sobre o atalho. O serviço as_integrador será iniciado, bem como o log da rotina será criado em diretório padrão.