API Cybersul
- Introdução
- Instalando e Configurando
- Comunicação da API da Cybersul
- Consumindo a API da Cybersul
- Envio de Logs das falhas de integração por e-mail.
- GuardianAPP (Monitoramento da API / Integradores)
- Arquivar Logs de Integração da API
- API/SP/Consulta e API/SP/Executa
Introdução
A API Cybersul tem por objetivo facilitar integrações entre o Sistema Cybersul e aplicativos\sistemas de terceiros.
Uma vez instalada, conta com chamadas(End Point's) para realização de consulta e\ou alteração\inserção\exclusão de cadastros, utilizando a arquitetura "REST" para comunicação.
Todas as funcionalidades disponíveis estão documentadas em uma modelagem(Swagger) que pode ser acessado através de uma página http montada pela própria API.
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.
Comunicação da API da Cybersul
Objetivo
Esta página tem como finalidade orientar o processo de teste de comunicação com a API CyberSul. Através de uma opção disponível no ERP, é possível realizar a verificação e obter uma resposta positiva, retornando o primeiro produto cadastrado no sistema, ou uma resposta negativa acompanhada de uma sugestão para identificar possíveis falhas na comunicação.
Consumindo a API da Cybersul
Objetivo
Esta página tem como objetivo guiar o processo de consumo da API da Cybersul por outras plataformas, fornecendo um exemplo de como realizar requisições e utilizar os recursos disponibilizados.
Envio de Logs das falhas de integração por e-mail.
1. Objetivo
O Envio de Log das falhas de integração por e-mail pode ser configurado de forma automática utilizando a ferramenta do SolAgent e permite ao usuário receber os alertas de um período pré configurado, agilizando no processo de identificação e resolução das falhas ocorridas.
1. Configurando o Envio
Baixar um arquivo template:
- Template - Logs integração.xml
-Layout geral para integração, contém logs do período mesmo se já foram resolvidos. - Template - Logs produtos.xml
-Layout otimizado para produtos, contém logs do período que continuam na fila de envio (não resolvidos).
Seguir instruções do vídeo abaixo:
GuardianAPP (Monitoramento da API / Integradores)
1. Objetivo
O objetivo do GuardianAPP é assegurar o monitoramento contínuo da API Cybersul e dos integradores, com uma funcionalidade crítica de reinicialização automática caso eles não respondam dentro de um tempo previamente definido.
Este procedimento é projetado para aumentar significativamente a estabilidade das integrações, além de notificar os administradores prontamente, permitindo-lhes tomar as medidas necessárias para solucionar qualquer falha de forma eficaz.
2. Configurando o GuardianAPP
3. Observações:
Dependendo das credenciais do usuário do Windows, o GuardianAPP pode enfrentar dificuldades para iniciar um aplicativo que esteja configurado para ser executado como administrador. Isso pode ocorrer devido às restrições de segurança impostas pelo sistema operacional.
Para iniciar o GuardianAPP junto com o login do windows é recomendado que não seja definido para executar como administrador, portanto, tanto o GuardianAPP quando os aplicativos monitorados devem ser iniciados com privilégios de usuário padrão.
Atenção: Devido a restrições de permissão nos servidores, tem sido necessário instalar a API Cybersul com privilégios de administrador. Isso exige que a execução do GuardianAPP também seja configurada para rodar como administrador nas suas propriedades, o que, por sua vez, desativa o início automático do aplicativo ao ligar o computador. Recomendamos orientar o usuário-chave da integração na empresa sobre essa questão. Para facilitar a verificação por esse usuário-chave, foi criada uma nova função no GuardianAPP, que será demonstrada no vídeo a seguir:
Arquivar Logs de Integração da API
1. Objetivo
2. Configurando o Envio
3. Recurso Sugerido
http://remoto.cybersulinformatica.com.br:8082/books/api-cybersul/page/guardianapp-%28monitoramento-da-api-integradores%29
API/SP/Consulta e API/SP/Executa
Olá, neste capítulo, vamos demonstrar a utilização dos endpoints disponibilizados na API Cybersul: -> API/SP/Consulta -> API/SP/Executa
Demonstração - API/SP
Olá, nesta página vamos demonstrar a utilização dos endpoints disponibilizados na API Cybersul:
- API/SP/Consulta
- API/SP/Executa