Estrutura Local
1. Sistema de Integração por KeyAccess Módulo API
Este recurso foi desenvolvido para empreendimentos que farão a integração do seu sistema ao KeyAccess Server por meio de API – Application Programming Interface na estrutura local.
O objetivo é promover benefícios com as trocas de informações e redução de esforços entre sistemas.
O KeyAccess possui um módulo específico que permite a interface entre os sistemas.
A documentação específica contendo os requisitos e métodos de integração será enviada para o time de desenvolvimento do sistema utilizado pelo cliente.
1.1. Instalando o módulo KeyAccess API – Application Programming Interface
O instalador do módulo de integração com o sistema de elevadores keyaccess-integration-api-module-[versão]-x86-x64.exe deverá ser obtido no endereço https://keyaccess.elektroo.info/files/.
Após fazer o download, execute o instalador no mesmo computador em que estiver instalado o sistema KeyAccess Server.
Notas:
- Todo o processo de instalação deverá ser executado na conta do usuário do sistema operacional Microsoft Windows que tenha por atribuição o perfil administrador;
- Durante o processo, o computador deverá ser reiniciado quando solicitado pelo instalador.
1.2. Configurando o módulo KeyAccess API
Para acessar a tela de configuração de configuração do módulo API acione o menu do sistema KeyAccess, clique em configurações avançadas e selecione a opção Módulo API.
Com isso, o sistema irá direcionar para a tela de configuração do módulo API.
Preencha o formulário observando as orientações da figura a seguir e clique em salvar.
Segue a figura que exibe o resultado de configuração como de exemplo.
1.3. Conta de usuário de integração
Após instalar e configurar o módulo KeyAccess API é necessário que seja criada uma conta de integração que servirá de autenticação do sistema do cliente ao KeyAccess Server.
Para criar uma conta de integração acesse o menu, clique sobre a seta ao lado do nome do usuário logado. Ao expandir a lista de opções, selecione contas de integração.
Na tela que lista as contas de integração, clique sobre o comando criar conta de integração.
Preencha o formulário observando as orientações da figura a seguir e clique sobre criar conta de integração. O nome adotado para identificação da conta de integração deve estar em minúsculo, sem acentos e espaços.
A figura a seguir exibe um exemplo de como o formulário deverá ser preenchido.
Nota:
- A senha da conta é igual ao nome da conta de integração. No exemplo da figura acima, o nome da conta de integração é containtegracao, portanto, a senha é containtegracao.
O registro criado será exibido na lista de contas de integração.
1.4. Dados a serem enviados para o cliente
Após realizar as configurações do módulo KeyAccess API e criar a conta de integração, a equipe técnica de implantação de manutenção do sistema deverá enviar as informações para o cliente.
Observe um exemplo de como enviar dos dados.
IP do servidor KeyAccess
192.168.0.20
URL
https://[nome do computador que hospeda o sistema KeyAccess Server]
Porta de comunicação com o módulo.
7436
Conta de integração
usuário: containtegracao
senha: containtegracao
1.5. Editar a conta de integração
Para editar uma conta de integração acesse o menu, clique sobre a seta ao lado do nome do usuário logado. Ao expandir a lista de opções, selecione contas de integração.
Na lista que exibe as contas de integração clique sobre o item que deseja editar.
Modifique as informações necessárias e clique sobre salvar alterações para gravá-las na base de dados do sistema.
Nota:
- Não é possível editar o nome da conta de usuário.
1.6. Remover uma conta de integração
Para editar uma conta de integração acesse o menu, clique sobre a seta ao lado do nome do usuário logado. Ao expandir a lista de opções, selecione contas de integração.
Na lista que exibe as contas de integração clique sobre o item que deseja remover.
Em seguida, clique em ações para expandir a lista e selecione a opção remover.
No modal de diálogo, acione o comando confirmar.
1.7. Sinótico
O sistema KeyAccess possui um sinótico que pode ser acionado através do comando localizado no lado inferior direito da tela, representado pela figura a seguir.
Com o encerramento das configurações, o resultado deve indicar a comunicação no estado online.