# Integração de Telefonia Móvel - Americanet

## Introdução

>[!TIP] O que é a Americanet?
>A MVNO [Americanet](https://parasuaempresa.americanet.com.br/) é uma plataforma que atua no mercado com soluções de tecnologia e conectvidade em **telefonia móvel**. Por meio da integração do sistema com a plataforma Americanet, é possível integrar de maneira eficaz sua operação de telefonia móvel, facilitando o gerenciamento ágil e eficiente de suas linhas.

- Este documento descreve o processo de integração entre o MVNO Americanet e o Sistema IXC Soft.
- O objetivo é centralizar o gerenciamento de serviços de banda larga e telefonia móvel em uma única plataforma.
- A integração visa simplificar a gestão de clientes, contratos, inadimplência e processos de ativação/manutenção.

> [!NOTA] **Acesso à Configuração**
> **Caminho:** Configurações > Integrações > Integrações MVNO/telefonia móvel

### 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
- Unificação do gerenciamento de banda larga e telefonia móvel;
- Simplificação de processos operacionais;
- Melhoria na gestão de inadimplência;
- Ampliação da oferta de serviços de telecomunicações.

## Configuração da Integração

### Passo 1: Cadastro da Integração
Neste passo, é efetuado o cadastro da integração. Este processo permite a comunicação e troca de dados entre o sistema e a plataforma **Americanet**.

1. Acesse o formulário de [[integracoes mvno telefonia movel|Integrações MVNO Telefonia Móvel]] através do caminho: Configurações > Integrações > Integração MVNO/Telefonia Móvel;
2. Pressione o botão **Novo**;
3. Selecione **Americanet** no campo **MVNA**;
4. Insira as informações fornecidas pela Americanet nos campos:
	- **Login:** informação utlizada para identificar e acessar os dados da plataforma, necessários para a integração. Insira o login disponibilizado pela Americanet para o uso da integração;
	- **Senha:** serve como uma chave de acesso, permitindo que ocorra a comunicação entre o sistema e a Americanet. Insira a senha informada pela plataforma.
	  
5. Clique em **Salvar** para validar a criação da integração e concluir o cadastro;
   
Campos preenchidos automaticamente:
- **Token:**  Gerado automaticamente após salvar a integração, serve como autenticador entre as plataformas, definindo a comunicação adequada entre ambas;
- **Data atualização token:** é registrado o horário de atualização do token toda vez que existe alteração na integração.

>[!CAUTION] **Importante:** 
>As credenciais são essenciais para estabelecer a conexão segura entre os sistemas e são fornecidas pela plataforma credenciada.

### Passo 2: Configuração do Produto de Telefonia Móvel (MVNO)
O cadastro do produto de MVNO é essencial para a gestão do produto no contrato, faturamento e também para permitir a ativação da linha MVNO, uma vez que o produto se relaciona com a integração pelos planos disponibilizados pela plataforma.

>[!INFO] **Importante:**
>O cadastro do produto no sistema é respectivo ao pacote disponível para a plataforma.

1. Acesse o formulário de [[cadastro de produtos|Cadastro de Produtos]] através do caminho: Sistema > Cadastros > Produtos;
2. Pressione o botão **Novo**;
3. Preencha os campos obrigatórios na aba **Produtos** e na aba **Planejamento**;
4. Acesse a aba **Telefonia Móvel**;
5. No campo **ID Integração** selecione a integração cadastrada anteriormente;  
	- **ID Plano integração:** Clique em **Buscar plano integração** para buscar os planos da plataforma, selecione o plano respectivo ao produto que está sendo cadastrado;  
	- **ID Produto IXC:** O ID do produto criado no sistema para controle do plano de telefonia móvel;  
	- **Tipo referência:** Contrato.
	- **Ativo:** marque como **Sim**;
	  
>[!NOTA]  Atenção:
>O ID Plano integração é respectivo à descrição do pacote na plataforma.
>

6. Clique em **Salvar** para validar e finalizar o cadastro do produto.


### Passo 3: Produto no Contrato
Para realizar a gestão do contrato associado ao serviço de telefonia móvel, é necessário vincular o produto de MVNO ao contrato. Esta ação permite realizar a geração do faturamento, emitir notas fiscais e também efetuar ativação da linha associada à integração. Esta ativação pode ocorrer diretamente pelo contrato ou por [[formulario planos de venda|Formulário Planos de Venda]].

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 "MVNO/Telefonia Móvel" e no campo **Produto/Serviço**, clique na lupa e selecione o produto de MVNO cadastrado. Clique em **Salvar** para validar as configurações.

> [!Caution] Atenção:
> O campo **Tipo** precisa, **obrigatoriamente**, estar marcado como **MVNO/Telefonia móvel** para a usabilidade da integração não sofrer inconsistências e apresentar o funcionamento adequado.

### Passo 4: Cadastro e Ativação da Linha MVNO
A ativação do da linha MVNO consiste em realizar a ativação de um novo numero ou solicitar a portabilidade de uma operadora para a Americanet.

>[!Caution] Atenção: 
>Somente é possível realizar o cadastro de uma linha MVNO em contratos que estão com status **ativo**.

###### **4.1: Ativação de número novo**
1. Ainda no contrato do cliente, navegue até a aba **Linha MVNO**;
2. Clique no botão **Novo** e preencha os campos apresentados:
	- **API:** Selecione a opção Alterar na API e no IXC;
		- **Alterar na API e no IXC:** ao utilizar essa opção, o sistema promoverá a comunicação entre o IXC Provedor e a plataforma. Toda requisição de alteração na linha MVNO será enviada para a plataforma Americanet, garantindo que os dados sejam sincronizados.
		 - **Ignorar API e alterar apenas no IXC:** ao utilizar essa opção, o sistema não utilizará a API da Americanet, resultando em nenhuma comunicação com ela. Todas as alterações feitas serão refletidas apenas no IXC Provedor, sem afetar a linha MVNO na plataforma MVNO.
		   
	- **Integração:** Clique na lupa e selecione o ID da integração da plataforma Americanet;
	- **Produto relacionado:** Deve inserir um produto IXC/MVNO, o qual foi cadastrado em **Produtos** e que esteja vinculado ao contrato do cliente;
	- **SIM card:** Número do cartão repassado pela integrada, deve conter 20 caracteres. Clique no botão **Buscar simcards disponíveis** e selecione o número do cartão que ficará relacionado à esta linha;
	- **Portabilidade:** Marque como **Não**;
	- **DDD**: Inserir DDD para que seja retornado o número do telefone equivalente ao DDD passado;
	- **Número do telefone:** Este é o número de telefone que ficará vinculado à linha, selecione o número que será utilizado e preencha o campo;

3. Após informar todos os campos, clique em **Salvar**.
4. Campos preenchidos automaticamente:
	- **ID contrato integração:** ao cadastrar a linha MVNO no IXC, este campo é preenchido como um retorno da plataforma Americanet, indicando o ID do cadastro da linha na plataforma;
	- **Status linha:** indica o status de uso da linha;
	-  **Saldo:** campo somente de leitura para visualização do saldo disponível para a linha. Permite a inclusão de [[dados adicionais mvno|Dados Adicionais MVNO]].


###### **4.2: Ativação de número existente (portabilidade)**
1. Ainda no contrato do cliente, navegue até aba **Linha MVNO**;
2. Clique no botão **Novo** e preencha os campos apresentados:
	- **API:** Selecione a opção Alterar na API e no IXC;
		- **Alterar na API e no IXC:** ao utilizar essa opção, o sistema promoverá a comunicação entre o IXC Provedor e a plataforma. Toda requisição de alteração na linha MVNO será enviada para a plataforma Americanet, garantindo que os dados sejam sincronizados.
		 - **Ignorar API e alterar apenas no IXC:** ao utilizar essa opção, o sistema não utilizará a API da Americanet, resultando em nenhuma comunicação com ela. Todas as alterações feitas serão refletidas apenas no IXC Provedor, sem afetar a linha MVNO na plataforma MVNO.
		   
	- **Integração:** Clique na lupa e selecione o ID da integração da plataforma Americanet;
	- **Produto relacionado:** Deve inserir um produto IXC/MVNO, o qual foi cadastrado em **Produtos** e que esteja vinculado ao contrato do cliente;
	- **SIM card:** Número do cartão repassado pela integrada, deve conter 20 caracteres. Clique no botão **Buscar simcards disponíveis** e selecione o número do cartão que ficará relacionado à esta linha;
	- **Portabilidade:** Marque como **Sim**;
	- **DDD**: Inserir DDD para que seja retornado o número do telefone equivalente ao DDD passado;
	- **Número de Telefone:** Informar o número a ser portado;
	  
3. Após informar todos os campos, clique em **Salvar**.
4. Campos preenchidos automaticamente:
	- **ID contrato integração:** ao cadastrar a linha MVNO no IXC, este campo é preenchido como um retorno da plataforma Americanet, indicando o ID do cadastro da linha na plataforma;
	- **Status linha:** indica o status de uso da linha;
	- **Status portabilidade:** ao ativar a linha como portabilidade, esta informação será preenchida como **Aguardando ativação.** Com a portabilidade concluída, o status é alterado para **Concluída.**
	- **Saldo:** campo somente de leitura para visualização do saldo disponível para a linha. Permite a inclusão de [[dados adicionais mvno|Dados Adicionais MVNO]].
	  
	  
>[!SUCCESS] Finalização:
Após realizar a ação de todos os passos, a linha estará pronta para uso. Em casos de portabilidade a linha ficará com status **Aguardando ativação** até que o processo seja concluído. O status é alterado pela [[tarefa - consultar portabilidade|Tarefa - Consultar Portabilidade]] ou então a partir da [[consulta manual de portabilidade - mvno|Consulta manual de portabilidade - MVNO]]

>[!INFO] **Importante:**
>O controle de acesso é feito diretamente pelas ações do contrato ou manualmente nos botões de Status da linha (bloqueio e liberação).


## Casos de Uso

### 1. Controle de Acesso Pelas Ações do Contrato
É possível realizar o gerenciamento do status da linha diretamente pelo sistema, mediante o status do contrato. Quando existe uma linha MVNO vinculada em um contrato, toda ação realizada no status do contrato e status de acesso irá refletir no status da linha, sendo esta alterada também e impactando no consumo do cliente final.  
  
#### Legenda - impacto do status do contrato na linha MVNO:

- **Ativo:** ao contrato que estiver com status de **ativo** e seu status de acesso também constar como **ativo**, a linha deve admitir o status de **Ativa**;
- **Bloqueio manual/automático:** ao contrato que for bloqueado por inadimplência de forma manual ou automática, assumindo o status de Bloqueio manual ou Bloqueio automático, a linha sofrerá bloqueio total, interrompendo totalmente o consumo do cliente;
- **Financeiro em atraso:** ao contrato que assumir o status de acesso do contrato para Financeiro em atraso, a linha sofrerá **bloqueio parcial**, interrompendo parcialmente o consumo do cliente;
- **Liberação manual ou automática:** é possível realizar o desbloqueio do contrato mediante o pagamento ou renegociação da mensalidade, por meio da liberação manual ou **automática** a partir do pagamento do título que ocasionou o bloqueio total ou parcial, ativando automaticamente o contrato ou manualmente;
- **Cancelamento:** ao cancelar/desativar o contrato, a linha irá respeitar o status do contrato e também será cancelada, admitindo o status de **Inativa**.


### 2. Controle de Acesso pelas Ações da Linha MVNO
É possível realizar o gerenciamento do status da linha diretamente pelo IXC, de modo que o sistema permite a alteração manual do status diretamente pela linha e não somente pelo contrato.  
Para alterar o status da linha, siga os passos a seguir:

1. Acesse o contrato do cliente;
2. Clique na aba Linha MVNO;
3. Selecione o botão de Editar;
4. Clique sobre o botão Status;
5. Selecione a opção de status que deseja aplicar à linha MVNO;  

#### Legenda - status:

- **Bloqueio roubo:** altera o status da linha para **Bloqueio roubo**, interrompendo totalmente o consumo do cliente devido ao dispositivo/simcard ter sofrido roubo;
- **Cancelar linha:** altera o status da linha para **Cancelada**, efetuando o cancelamento total e permanente da linha;
- **Liberar linha:** realiza a liberação da linha quando estiver em bloqueio, retomando o consumo do cliente. A linha assume o status de **Ativa**;
- **Bloqueio parcial:** altera o status da linha para **Bloqueio parcial**, interrompendo parcialmente o consumo do cliente;
- **Bloqueio perda:** altera o status da linha para **Bloqueio roubo**, interrompendo totalmente o consumo do cliente devido à perda do simcard/dispositivo;
- **Bloqueio uso indevido:** realiza a alteração do status da linha para Bloqueio Uso Indevido, interrompendo totalmente o consumo do cliente por ser identificado mau uso do simcard;
- **Bloqueio total:** realiza a alteração do status da linha para **Bloqueio total**, interrompendo totalmente o consumo do cliente.

### 3. [[trocar titularidade - mvno|Trocar titularidade - MVNO]]
 O sistema permite a alteração da titularidade da linha, de modo que uma linha já cadastrada possa ser transferida para outro contrato.

>[!Caution] Critérios de transferência entre contratos:
>- A linha deve estar com o status **Ativo**;
>- O status da portabilidade, caso a linha seja portada, deve estar como **Concluída**;
>- O contrato que receberá a linha deve estar com o status **Ativo**.
>- O contrato que receberá a linha deve ser do novo titular.

Para realizar uma troca de titularidade, siga os seguintes passos:
1. Acesse a linha MVNO que deseja realizar a alteração do contrato;
2. Selecione o botão **Trocar titularidade**;
3. No campo **ID contrato novo**, clique sobre a lupa e selecione o contrato que passará a ter vínculo com a linha MVNO.
4. Clique em confirmar para validar a troca de titularidade.


## Fluxo de Trabalho

```mermaid
graph TD
    A[Início] --> B[Cadastro de Cliente]
    B --> C[Criação de Contrato]
    C --> D[Seleção de Plano Móvel]
    D --> E[Acesso à Aba MVNO]
    E --> F[Preenchimento de Dados da Linha]
    F --> G[Envio para Ativação]
    G --> H[Confirmação da Americanet]
    H --> I[Linha Ativa]
    I --> J[Monitoramento e gerenciamento]
```

## Considerações Finais
A integração entre a plataforma Americanet e o sistema proporciona uma solução completa para o gerenciamento de serviços de telecomunicações. Esta integração resulta em operações mais eficientes e uma experiência aprimorada para o cliente. É fundamental estar a par das diretrizes de utilização e eventuais atualizações da plataforma integrada, garantindo assim o máximo aproveitamento das funcionalidades oferecidas.

## Etiquetas
#Integracoes #IntegracoesTelefoniaMovel #IntegracaoAmericanet #MVNO #Americanet 

## Leia Também
-  [Americanet](https://parasuaempresa.americanet.com.br/produtos/mvno/)
- [[integracoes|Integrações]]
- [[integracoes mvno telefonia movel|Integrações MVNO Telefonia Móvel]]
- [[dados adicionais mvno|Dados Adicionais MVNO]]
- [[tarefa - consultar portabilidade|Tarefa - Consultar Portabilidade]]
- [[consulta manual de portabilidade - mvno|Consulta manual de portabilidade - MVNO]]
- [[trocar titularidade - mvno|Trocar titularidade - MVNO]]