A Excia API permite que diferentes sistemas operem de forma integrada, como se fossem um único ambiente. Essa integração possibilita melhores resultados ao permitir que diversos sistemas acessem e consultem informações do ERP, além de inserir, excluir e até mesmo alterar dados diretamente a partir de outras plataformas.
Instalação:
1 – Instalação do EXCIAServidorAPL.exe
- Realize o download do arquivo pelo link:
- Caso não consiga pelo link, acessar pelo seguinte caminho:
- Intranet > Downloads > Versões > EXCIAServidorAPL > EXCIAServidorAPL.zip
- Após o download, descompacte o conteúdo diretamente na raiz do sistema.
Será extraído o arquivo: EXCIAServidorAPL.exe - Observação: Este arquivo já é instalado automaticamente ao atualizar o sistema. Portanto, só é necessário realizar esta instalação caso o aplicativo não esteja presente na pasta raiz.
2 – Instalação do EXCIAServidorAPL_Install.bat
- Baixe o instalador pelo link:
- Caso não consiga pelo link, acessar pelo seguinte caminho:
- Intranet > Downloads > Versões > EXCIAServidorAPL > EXCIAServidorAPL_Install.bat
- Coloque o arquivo diretamente na raiz do sistema.
- Execute o arquivo EXCIAServidorAPL_Install.bat como administrador.
-
O serviço será instalado e vinculado automaticamente ao aplicativo EXCIAServidorAPL.exe.
3 – Configurações do EXCIAServidorAPL
- Será necessário liberar uma porta para entrada e saída de dados da API.
- Por padrão, utilizamos a porta 211.
-
No arquivo TI.ini, dentro da raiz do sistema, crie a seguinte tag:
[Servico2]
Porta= (numero da porta)
4 – Considerações importantes:
- Caminho do executável: a instalação padrão vincula o serviço ao caminho
C:\EXCIA\EXCIAServidorAPL.exe.
Caso esteja em outro diretório, edite o arquivo EXCIAServidorAPL_Install.bat antes de executar:- Clique com o botão direito > Editar
- Ajuste a tag binpath para o caminho correto.
- Serviço já existente: caso já exista outro serviço instalado, edite o mesmo arquivo (EXCIAServidorAPL_Install.bat) e altere a tag displayname para um novo nome de serviço.
- Empresa consultada: por padrão, a consulta da API é feita para a empresa 001.
Para consultar outra empresa, adicione no TI.ini, dentro da tag[Servico2]: - Importante: as consultas são limitadas a uma única empresa.
Caso seja necessário consultar várias empresas, o ideal é incluir as tabelas diretamente no ARQLOCAL.
- Para monitorar requisições feitas à API, habilite a variável:
Assim será possível acompanhar a quantidade de requisições, métodos utilizados e IP de origem.
- É possível limitar o número de requisições por segundo com a variável:
Essa configuração não é obrigatória, mas é altamente recomendada para evitar instabilidade por excesso de requisições.
Mais informações: API EXCIA – Limite de requisições
5 – Teste de funcionalidade
- Após aplicar as configurações, reinicie o serviço
EXCIAServidorAPL. - Para testar a API:
- Abra um navegador e digite o endereço do servidor onde a API está instalada, informando a porta e o método
/TesteConexao. - Exemplo:
-
O retorno esperado será:
- Observação: Para utilização da API é necessário possuir um token de acesso.
A solicitação deste token deve ser realizada por e-mail, informando os seguintes dados:- Razão Social:
- CNPJ:
- Técnico Responsável:
- Telefone:
- E-mail do Técnico Responsável:
- O pedido deve ser enviado para: suporte@exciasistemas.com.br ou rodrigo@exciasistemas.com.br.
Com a API configurada e em funcionamento, as consultas ao EXCIA ERP podem ser realizadas conforme documentado.
Acesse a documentação oficial de consultas para detalhes sobre os métodos disponíveis. documentação