Parâmetro API: Entenda sua Função e Como Utilizá-lo
Entendendo a aplicação do parâmetro
O parâmetro API está disponível exclusivamente no módulo de Integrações, responsável por gerenciar a comunicação entre o IXC Provedor e plataformas terceiras. Sua função está diretamente ligada ao controle da comunicação com essas plataformas, por isso, não está disponível em outros fluxos do sistema.
Atualmente, ele se aplica às seguintes integrações:
💡 Conceitos fundamentais
É importante que você saiba os seguintes conceitos antes de avançar para os próximos tópicos!
- Integração: quando dois sistemas trabalham juntos para facilitar operações. Na prática, quando o IXC Provedor integra com plataformas terceiras, ele está conversando com a plataforma de streaming ou de telefonia para trocar informações. Este processo permite, principalmente, que você realize as operações de gestão em um único local.
- API: uma API atua como uma ponte ou mensageiro que auxilia dois sistemas a conversarem entre si e trocarem informações. A API é como um carteiro que leva essas informações de um lugar para o outro, para que as informações existam em dois locais distintos ao mesmo tempo, mesmo que sejam sistemas diferentes. A API permite que a integração seja feita.
- Parâmetro: é uma configuração dentro do sistema que controla como ele deve funcionar. Ajustar um parâmetro é como escolher uma regra para que o sistema se comporte do jeito que você precisa.
O que significa o parâmetro API?
O parâmetro API foi desenvolvido para operações do módulo de Integrações no IXC Provedor. Este parâmetro tem como objetivo permitir ajustes no sistema de forma controlada, oferecendo ao usuário a possibilidade de manusear a comunicação com as plataformas integradas. Portanto, a nomenclatura API define se o sistema irá ou não se comunicar com a plataforma integrada, como as operadoras de telefonia móvel e plataformas de conteúdo streaming e de TV aberta.
É importante destacar que o parâmetro API não altera permanentemente o comportamento do sistema. Ele atua apenas durante a execução da ação específica, como a criação ou edição de um usuário de TV ou linha MVNO. Ou seja, ao selecionar a opção “Apenas no IXC”, o sistema deixará de se comunicar com a plataforma integrada somente naquela operação pontual.
Após essa ação, o sistema retoma seu comportamento padrão, considerando a comunicação ativa com a API. Isso significa que, se o registro for utilizado em rotinas automáticas ou processos futuros, a comunicação com a API será restabelecida normalmente. Portanto, é essencial garantir que os dados estejam corretos, pois inconsistências poderão gerar falhas de ativação ou sincronização.
Estrutura do Parâmetro
O parâmetro está presente e pode ser utilizado em operações de ativação e/ou edição de:
A funcionalidade oferece duas opções, permitindo que você defina como o sistema deve agir. Este parâmetro irá estabelecer onde determinada operação será executada: na plataforma integrada (API) ou apenas no sistema IXC. Ele oferece duas opções distintas:
- Na API e no IXC (padrão): A ação será realizada tanto na plataforma externa (API) quanto no sistema IXC, garantindo sincronização completa entre os dois ambientes. O sistema mantém esta opção habilitada como padrão para evitar erros de comunicação.
- Apenas no IXC: A ação será efetuada somente no sistema IXC, sem comunicação ou impacto na plataforma integrada, permitindo ajustes locais e temporários.
Este parâmetro favorece a sincronização de dados entre as plataformas integradas, economizando tempo e retrabalho, pois permite corrigir informações sem a necessidade de refazer processos. Além disso, promove maior autonomia e controle direto sobre as operações.
Como utilizar?
Não se esqueça!
O parâmetro Apenas no IXC é temporário: ele atua somente durante a ação executada. Após a operação, o sistema restaura automaticamente a opção padrão Na API e no IXC, garantindo a continuidade da integração.
O parâmetro é exibido em ações de ativação e edição de usuários ou linha de telefonia móvel. Portanto, siga os critérios descritos a seguir para fazer o uso adequado da ferramenta.
Novas ativações
Para cada ativação nova no sistema, isto é, um usuário ou linha MVNO que ainda não existe, o parâmetro API deve estar habilitado na opção Na API e no IXC. Esta ação garante que, ao realizar a criação de um novo usuário ou linha, esta informação existirá em ambas as plataformas (no IXC Provedor e na plataforma de streaming/operadora de telefonia).
Inclusão de usuários/linhas MVNO já existentes
Quando um usuário de TV ou uma linha de telefonia móvel já foi cadastrada previamente na plataforma externa (MVNO/TV), mas ainda não está registrada no IXC Provedor, é possível fazer a inserção manual desses dados sem gerar conflitos de comunicação. Nesses casos, o parâmetro API deve ser configurado como Apenas no IXC. Essa opção garante que o sistema não envie comandos para a plataforma integrada, evitando que registros duplicados sejam criados ou que processos automáticos indevidos sejam acionados. Em seguida, depois de registrar esta informação no IXC Provedor, o sistema irá estabelecer comunicação devido aos dados estarem equivalentes em ambas as plataformas.
Uso recomendado
Utilize a opção Apenas no IXC somente quando os dados já estiverem ativos na plataforma externa. Isso permite sincronizar e regularizar as informações localmente, mantendo a operação alinhada sem interferência na plataforma original.
Atenção redobrada ao incluir uma ativação já existente!
O sistema somente estabelecerá comunicação com a plataforma com um usuário TV ou linha MVNO que já existe se todos os dados forem iguais. Isso inclui:
- Informações do cadastro do cliente (telefone, e-mail, endereço);
- Informações do próprio usuário TV (login, senha, equipamento caso utilize, produto relacionado, e demais informações de autenticação do login)
- Informações da linha MVNO (SIMCard, número de telefone, produto utilizado e demais informações da linha)
Atualizações de informações
Para atualizações (edições) de dados em usuários TV e linhas MVNO, é necessário validar qual plataforma integrada está sendo utilizada e se ela suporta atualizações através do IXC Provedor. Se este for o caso, utilize o parâmetro habilitado na opção Na API e no IXC. Desta forma, os dados serão refletidos e sincronizados em ambos os sistemas.
Quando não usar Apenas no IXC?
Evite retrabalho e falhas!
Sempre que precisar interromper temporariamente a comunicação com a plataforma integrada, tenha um motivo claro e retorne à configuração padrão assim que concluir o ajuste. Configure o parâmetro com atenção antes de confirmar qualquer ação, pois o uso incorreto pode causar retrabalho, falhas, perda de tempo com correções manuais e falhas na comunicação entre os sistemas.
Apesar de ser uma ferramenta flexível e útil, o parâmetro API deve ser utilizado com responsabilidade. Existem situações em que seu uso inadequado pode gerar falhas, retrabalho e inconsistência entre os sistemas. Veja abaixo quando não aplicar este parâmetro:
🚫 Em ativações novas com a opção Apenas no IXC
Se você está criando um novo usuário TV ou linha MVNO, o parâmetro não deve estar na opção Apenas no IXC. Isso bloqueia a comunicação com a plataforma integrada e impede que o serviço seja efetivado corretamente. Para novos cadastros, sempre utilize Na API e no IXC.
🚫 Sem confirmação de que o dado já existe na plataforma externa
Não utilize Apenas no IXC se você não tiver certeza de que o usuário ou linha já estão ativos na plataforma de origem (MVNO ou TV). Caso contrário, os sistemas ficarão desalinhados e o suporte técnico pode se tornar mais complexo.
🚫 Para testes ou experimentações no ambiente de produção
Evite usar esse parâmetro como forma de teste no ambiente real. A alteração da configuração sem um objetivo claro pode gerar efeitos inesperados tanto no IXC quanto na plataforma integrada.
🚫 Para uso em rotinas automáticas
O parâmetro API, configurado como Apenas no IXC, opera somente em alterações manuais nos formulários de usuários de TV e linhas de telefonia móvel. As funções automáticas de bloqueio e liberação continuam a se comunicar com a plataforma normalmente. Em caso de sucesso, o sistema gerenciará o acesso do contrato em ambas as plataformas. Caso a comunicação com a plataforma não seja estabelecida pelo usuário ou linha, o sistema retornará uma mensagem de erro e continuará com o procedimento de bloqueio do contrato, mas não bloqueará o usuário TV ou linha de telefonia móvel, mantendo ativo o consumo do cliente.
Sempre que for usar as informações dos usuários de TV ou de linhas de telefone móvel, certifique-se de usar exatamente os mesmos dados em todas as plataformas que estiver usando.**
Para não esquecer: Um guia visual de quando usar cada configuração
| Situação | Configuração correta do parâmetro | Motivo |
|---|---|---|
| Ativação de um novo usuário de TV | ✅ Na API e no IXC | Para que o usuário seja criado tanto no IXC quanto na plataforma de streaming. |
| Ativação de uma nova linha MVNO | ✅ Na API e no IXC | Garante que a linha seja cadastrada também na operadora de telefonia móvel. |
| Inclusão de um usuário TV que já existe na plataforma externa, mas não no IXC | ✅ Apenas no IXC | Evita conflito de dados ou duplicidade de login ao registrar esse usuário apenas no IXC. |
| Inclusão de uma linha MVNO que já foi ativada externamente, mas ainda não está no IXC | ✅ Apenas no IXC | Permite regularizar o cadastro localmente sem enviar novos comandos para a operadora. |
| Atualização de informações em usuário TV ou linha sincronizada, e a plataforma suporta alterações | ✅ Na API e no IXC | Garante que as informações sejam refletidas também na plataforma externa. |
Considerações finais
O parâmetro API é uma ferramenta essencial que oferece flexibilidade na gestão de dados entre o IXC Provedor e plataformas integradas. Embora ofereça flexibilidade e autonomia, o uso desse parâmetro requer atenção. Configurações indevidas podem causar falhas de ativação, dados inconsistentes entre sistemas ou até retrabalho operacional. Portanto, antes de utilizar essa configuração, avalie o cenário e os impactos. Após ajustes pontuais, retorne à configuração padrão sempre que for necessário garantir a comunicação entre os sistemas. O uso consciente do parâmetro garante maior controle, segurança e eficiência nas integrações do seu provedor.
Etiquetas
API Integracoes IntegracaoMVNO IntegracaoTV
