Instalando e Configurando

O processo de instalação de de configuração estão todos dentro do sistema, sendo assim seguiremos os passos:

1. Abrir o sistema

2. Abrir a configuração dos "Dados da Empresa" - Menu > Dados da Empresa

3. Abrir a aba "Integração"

4. Marcar o campo "Habilita uso da API Cybersul" com o valor "Sim"

5. Reiniciar o sistema

6. Abrir a tela de "Configuração da API e Integrações" - Menu > Outros > Integrações"

Observação: Caso a tela de "Configuração da API e Integrações" não conste no Menu -> Outros , verificar se está ativo a opção no Menu de usuário ou grupo de usuário.

 

7. Porta da API, por padrão virá com o valor 888 para banco de produção e 887 para banco de testes. Caso estas portas já estejam em uso pode-se utilizar qualquer porta livre.

8. Por padrão o usuário deve ser "APIUSER", caso haja necessidade poderá ser outro usuário.

9. Senha deverá ser a mesma senha que foi utilizada para criar o usuário no cadastro de usuários do sistema.

10. Nome do serviço, por padrão, é "APICYBERSUL"
     * Ambiente de produção e de testes devem ter nomes diferentes.

11. A pasta API pode ser qualquer uma, de preferência que não esteja dentro da pasta do solution para que não haja conflitos na hora de atualizar o sistema
     * Definir privilégio de leitura e gravação na pasta para o usuário do Windows onde será instalado a API.

12. Campo Habilitar Log, para funcionamento normal da API, deve conter o valor "0 - Desligado"
     * este campo somente terá outros valores se precisarmos de informações adicionais para solução de problemas

13. Botão "Atualiza/Instala API"
     * Necessário estar executando o sistema como Administrador.
     * Para o caso de não estar instalada a API, será:
        - Criada a pasta especificada
        - Copiado os arquivos necessários
        - Instala o serviço no windows
        - Inicializa o serviço
     * Para o caso de estar instalada
        - Para o serviço, se ele estiver rodando
        - Sobrescreve os arquivos pelos mais novos
        - Inicializa o serviço

14. Botão "Remover Registro do serviço"
        - Para o serviço
        - Remove serviço registrado no windows

15. Botão "Reiniciar Serviço"
        - Para o serviço
        - Espera o serviço parar
        - Inicia o serviço

16. Botão "Parar Serviço"
        - Para o serviço

17. Botão "Iniciar Serviço"
        - Inicia o serviço

18. Link "Acessar Documentação Técnica"
        - Abre a documentação das funcionalidades da API, o que também serve para testar se a api está configurada corretamente
        - Link da documentação técnica é formado por: http://(ip_do_servidor):(porta_da_api)/api/doc

O Link "Acessar Documentação Técnica" só irá abrir após API estar configurada.

Para acessar a API, na rede interna, o firewall do windows deve estar configurado para permitir fluxo de dados na porta TCP onde a API está configurada.
Se o acesso funcionar internamente por "localhost" e não por IP deve ser verificado as configurações do antivírus local.
Para acessar a API, pela rede externa (Internet), a porta TCP deverá estar configurada no seu roteador. O acesso será feito através do IP externo de sua rede.
As configurações de porta e acesso externo devem ser feitas pelo profissional de TI da contratante.

**Verificar se a fbclient.dll está na pasta da ApiCyberSul.exe.