# Integrações IoT - Olli (Beta)

## Introdução


>[!tip] Atenção!
>Este conteúdo está presente na **versão [[clientes beta ixc soft|Beta]]** do sistema.
>A disponibilidade desta integração na **versão Estável** será a partir de Abril de 2025.

---

>[!TIP] **Definição - Olli:**
>A [Olli](https://olli.vc/) é uma plataforma que entrega soluções de lugares inteligentes de última geração, visando promover o acesso facilitado à automação residencial. Seu foco está em integrar tecnologias avançadas para proporcionar maior conforto, segurança e eficiência energética aos usuários, transformando casas comuns em ambientes conectados e automatizados. 

A integração IoT Olli permite estabelecer comunicação entre a plataforma Olli e o Sistema IXC, possibilitando o gerenciamento e monitoramento de dispositivos IoT de forma centralizada e eficiente. Com essa funcionalidade, é possível controlar e acompanhar o desempenho de diversos dispositivos conectados, desde sensores até atuadores, em tempo real.

Esta documentação fornece instruções detalhadas sobre como configurar e utilizar esta integração, abordando desde os requisitos iniciais até a personalização de recursos avançados. Além disso, inclui exemplos práticos, soluções para problemas comuns e orientações para garantir uma experiência otimizada na automação e no gerenciamento de dispositivos inteligentes.

> [!NOTA] **Acesso à Configuração**
> **Caminho:** Configurações > Integrações > Integrações IoT

### Requisitos de Uso
A contratação de um **módulo** é necessária para a liberação da integração no sistema IXC. Para realizar a contratação do módulo, entre em contato conosco mediante um atendimento direcionado ao departamento **Administrativo Financeiro**.

## Entrega de Valor
- **Gerenciamento centralizado de dispositivos IoT:** Simplifica a administração de todos os dispositivos conectados em uma única plataforma, oferecendo maior controle, organização e eficiência nas operações;
- **Monitoramento em tempo real:** Proporciona visibilidade imediata do status e desempenho dos dispositivos IoT, permitindo respostas rápidas a eventos e maior confiabilidade no sistema;
- Integração de dados IoT com outros módulos do Sistema;
- Permite o registro de mais de uma integração de automação residencial Olli.

## Estrutura da Funcionalidade
A funcionalidade está estruturada a partir dos seguintes procedimentos:

1. Cadastro dos dados API da integração [[integracoes iot - olli|Integrações IoT - Olli]];
2. [[cadastro de produtos|Cadastro de Produtos]] de IoT para gerenciamento no contrato;
3. Vínculo do produto de IoT no [[formulario contrato do cliente|Formulário Contrato do Cliente]];
4. Criação da licença IoT;
5. Controle de acesso à licença.

## Configuração da Integração

### Passo 1: Cadastro Inicial
Para estabelecer a comunicação entre as plataformas, siga estas etapas:

1. Acesse o formulário de [[integracoes iot|Integrações IoT]] através do caminho: Configurações > Integrações > Integrações Iot;
2. Clique no botão **Novo**;
3. No campo Integração, selecione **Olli**
4. Preencha os campos **Client ID** e **Client Secret** com as informações fornecidas pela Olli:
	- **Client ID:** identificador único atribuído à API. Insira a informação fornecida pela Olli;
	- **Client Secret:** chave que, associada ao Client ID, autentica um aplicativo que se conecta à API, neste caso, o sistema se conecta à API da Ollo. Insira a senha fornecida pela plataforma;
	
5. Clique em **Salvar** para finalizar o cadastro da integração.

### Passo 2: Cadastro do Produto
O cadastro do produto IoT permite registrar produtos compatíveis com a integração Olli para o gerenciamento do produto no contrato e para possibilitar a criação de licenças, mantendo a comunicação com a plataforma e espelhando as informações em ambos os softwares.
Para cadastrar o produto SVA associado à integração, siga as seguintes etapas:

1. Acesse o menu **Sistema** e depois selecione a opção **Cadastros**;
2. Em seguida, clique em **Produtos**;
3. Clique no botão **Novo** e preencha os campos principais de cadastro do **Produto** nas aba **Produtos** e **Planejamento**;
4. Em seguida, acesse a aba IoT ainda no formulário de **Produto**;
5. Preencha os campos:
	- **ID integração IoT:** clique na lupa e selecione a integração IoT cadastrada. Caso tenha mais de uma integração em seu sistema, certifique-se de selecionar a integração adequada para o cadastro deste produto;
	- **Produto IoT:** clique no botão **Buscar produtos IoT** para que o sistema realize uma consulta dos pacotes disponíveis na plataforma para uso do cliente. Selecione a opção equivalente ao produto que está sendo cadastrado. O sistema irá listar os produtos IoT com base no campo **ID integração IoT** e, portanto, somente exibirá os pacotes da integração correspondente.
	  
6. Clique em **Salvar** para concluir o cadastro do produto.

### Passo 3: Produto no Contrato
Com o produto cadastrado e relacionado à integração, é necessário vinculá-lo ao contrato, para realizar o gerenciamento adequado do contrato e gerenciamento, mas também permitir a criação das licenças de uso, disponibilizando o acesso do cliente ao produto de forma efetiva.
Para incluir os produtos no contrato, siga os passos a seguir:

1. Acesse o [[formulario contrato do cliente|Formulário Contrato do Cliente]] através do caminho: Sistema > Cadastros > Contratos;
2. Pressione o botão **Editar** para acessar o contrato;
3. Navegue até a aba **Produtos** e clique no botão **Novo**. Defina o tipo do produto como **SVA** e no campo **Produto/Serviço**, clique na lupa e selecione o produto de IoT cadastrado.
4. Clique em **Salvar** para validar as configurações.

### Passo 4: Criação de Licença IoT
Após vincular o produto no contrato, acesse a [[public/menu sistema/cadastros/contratos/abas (contrato)/aba iot - contrato do cliente|Aba IoT - Contrato do Cliente]] no [[formulario contrato do cliente|Formulário Contrato do Cliente]] para estabelecer a comunicação do produto com a licença. Siga os passos abaixo:

1. Na [[public/menu sistema/cadastros/contratos/abas (contrato)/aba iot - contrato do cliente|Aba IoT - Contrato do Cliente]], clique no botão **Novo**;
2. Na aba **Licenças IoT**, preencha os campos:
	- **ID integração:** clique na lupa e selecione o cadastro da integração previamente cadastrada;
	- **Descrição:** insira uma breve descrição relevante sobre o produto vinculado;
	  
3. Após, clique em **Salvar**;
4. Siga até a aba **Produtos da licença** e clique no botão **Novo**;
5. Selecione todos os produtos dos quais a licença terá acesso;
6. Após concluir a seleção dos produtos, clique sobre o botão **Criar licença**;
7. Com a licença criada, será apresentado através do botão **Detalhamento da licença** todas as informações da licença. 

 >[!Caution] Atenção:
 A licença somente será ativa quando o cliente realizar a primeira ativação no aplicativo da Olli. Caso contrário, a licença terá o status de **Pendente** no sistema.


## Casos de Uso

### Ações do Contrato
A integração com a plataforma [[integracoes iot - olli|Integrações IoT - Olli]] valida ações sobre o contrato, impactando no status da licença, permitindo o controle de acesso pelo sistema e espelhando na plataforma credenciada.
#### Controle de acesso da licença a partir do status do contrato:

- **Bloqueio/Desbloqueio:** o bloqueio e desbloqueio ocorre a partir do status do contrato do cliente. Ao ser bloqueado, o contrato assume o status de Bloqueio (Manual ou Automático) e a licença também será bloqueada, assumindo o status de inativa na Olli. O desbloqueio do contrato libera o status de acesso da licença.
- **Cancelamento de contrato:** se ocorrer o cancelamento do contrato, a licença assumirá o status de inativa no sistema e na plataforma. Também é permitida a inativação manual da licença, através dos botões **Ativar** e **Desativar** dentro da aba **Licenças IoT**.

### Deleção de Licença
O sistema permite a deleção de uma licença cadastrada no contrato do cliente. Para efetuar este processo, é necessário que o cliente tenha ao menos uma integração ativa. Siga os passos descritos a seguir para realizar a deleção de uma licença IoT:

1. Acesse o [[formulario contrato do cliente|Contrato do Cliente]] através do caminho: Sistema > Cadastros > Contratos;
2. Selecione o contrato do cliente do qual deseja deletar a licença e clique em **Editar**;
3. Acesse a [[public/menu sistema/cadastros/contratos/abas (contrato)/aba iot - contrato do cliente|Aba IoT]];
4. Localize e selecione a licença da qual deseja deletar;
5. Clique em **Deletar** para remover o registro do sistema.


## Fluxo de Trabalho

```mermaid
graph TD
    A[Cadastro da Integração] --> B[Cadastro de Produto IoT]
    B --> C[Vínculo do Produto no Contrato]
    C --> D[Criação de Licença IoT]
    D --> E[Ativação do Dispositivo]
    E --> F[Monitoramento de Status]
```

## Considerações Finais
A integração **IoT Olli** oferece uma solução robusta e confiável para o gerenciamento de dispositivos IoT dentro do Sistema, permitindo uma administração eficiente e conectividade inteligente. Com ela, é possível configurar e monitorar dispositivos de maneira centralizada, otimizando processos e melhorando a experiência do usuário. Certifique-se de manter as credenciais de acesso (Client ID e Secret) seguras e atualizadas, uma vez que essas informações são essenciais para a autenticação e funcionamento contínuo da integração.

## Etiquetas
#Integracoes #IntegracoesIoT #IntegracaoOlli #Olli #Licencas

## Leia Também
- [[integracoes|Integrações]]
- [[integracoes iot|Integrações IoT]]
- [[formulario contrato do cliente|Formulário Contrato do Cliente]]