Como Integrar IXC Provedor Com CDN TV Via API

Introdução

Integração significa conectar e combinar informações de diferentes sistemas, permitindo que eles se comuniquem e compartilhem dados de forma eficiente. No nosso caso, queremos conectar o sistema IXC Provedor, que contém informações importantes, com a plataforma da CDN TV, que utiliza esses dados para oferecer serviços de transmissão de conteúdo.

Requisitos de Uso

Para utilizar este recurso, é necessário atender as seguintes condições:

• Gerar o token API e possuir um usuário com permissões necessárias para a manipulação de dados;
• Cadastro padronizado do método de vinculo do produto e tipo de login do cliente.

Entrega de Valor

• Permite a comunicação direta entre sistemas;
• Facilita a integração com novas ferramentas e plataformas, garantindo um ecossistema digital eficiente e flexível conforme a necessidade da organização;
• Gestão centralizada de informações de clientes e serviços;

Processo de Integração

Passo 1: Geração do token API

Para que a CDN TV possa acessar os dados do IXC, é necessário criar um Token de acesso e enviar para o suporte da CDN TV. Para isso, é preciso criar um usuário no sistema IXC com as informações necessárias.

1.1 Geração do token

Para gerar um token API, siga as etapas descritas a seguir:

1. Acesse menu Configurações > Usuários > Usuário;
2. No formulário Usuário, clique em Novo ou Editar, caso já tenha criado um usuário para a integração.

Lembre-se:

>É importante que o usuário seja exclusivo para a integração, para que os logs de alterações possam identificar se uma determinada ação foi realizada pelo usuário ou pela integração.

3. Após acessar o formulário de criação ou edição de usuários, você deve marcar a opção Permite acesso a API, na seção API. Essa opção é a responsável por gerar o Token utilizado para acessar os recursos do sistema via API. Depois de marcar a opção, clique em Salvar. Após salvar as alterações no formulário, o Token será gerado automaticamente no campo Token de acesso.

Atenção!

>O Token está vinculado ao usuário, portanto, se o e-mail ou a senha do usuário forem alterados, o Token também será alterado automaticamente. Além disso, se o grupo de usuários vinculado ao usuário não tiver as permissões necessárias, o Token não poderá acessar os recursos do sistema via API.

1.2. Criação de um Grupo de Usuários exclusivo para a integração API

Para ter um maior controle dos acessos que as integrações conseguem fazer no sistema e dos IPs que podem acessar o sistema via API, é recomendado criar um grupo de usuários exclusivo para as integrações via API. Siga as etapas descritas a seguir:

1. Acesse o Menu Configurações > Usuários > Grupo de usuários;
2. Na página dos grupos de usuários, clique em Novo ou Duplicar Grupo caso já exista um grupo com as permissões necessárias ou aproximadas.
3. Siga para a seção Redes permitidas para realizar a liberação da rede para viabilizar o acesso ao sistema.
4. Em seguida, acesse aba de Permissões para definir as permissões do usuário API.
5. Clique em Salvar para validar as modificações.

Permissões:

>As permissões a serem liberadas devem ser confirmadas com a integração. Confirme com a plataforma a seguir integrada quais são as ações que serão utilizadas no sistema para liberar as permissões adequadas. Caso tenha dúvidas de como alterar as permissões de um grupo de usuários, acesse: Permissões do Grupo de Usuários.

1.3. Liberando os IPs para a Integração

As integrações API normalmente solicitam a liberação de um IP para que o servidor onde está hospedado a aplicação tenha permissão de acesso ao sistema. Para liberar os IPs da integração no grupo de usuários, siga:

1. Acesse o Menu Configurações.
2. Selecione a opção Usuários.
3. Em seguida selecione a opção Grupo de Usuários.
4. Na página dos grupos de usuários, clique em Editar.
5. Siga na seção Permissão de login. No campo Redes permitidas, insira o IP do servidor da aplicação. Lembre-se de separar os IPs por ponto e vírgula (;).
6. Clique em Salvar para validar as modificações.

Atenção:

>Se você não quiser criar um grupo de usuários exclusivo para a integração, é possível liberar o acesso para os IPs das integrações inserindo-os no grupo de usuários vinculado ao usuário Token. No entanto, será necessário liberar os IPs das integrações e dos seus próprios usuários, para que não haja perda de acesso ao IXC Provedor.

Passo 2: Cadastro do produto CDN TV

A CDN TV disponibiliza algumas formas de vínculos possíveis para a integração, entretanto, todas elas dependem da criação de um produto com a descrição igual à informação do pacote de canais que consta na aplicação deles para que a validação ocorra corretamente. Desta forma, após recolher os dados referentes ao nome do produto, seguimos para seu cadastro no seguinte caminho:

1. Acesse o Menu Principal.
2. Selecione a opção Cadastros.
3. Em seguida, selecione a opção Produtos.
4. Na página dos produtos, clique em Novo e preencha os campos:

• Subgrupo de produtos: Selecionado conforme sua preferência, podendo ser o subgrupo de serviços, TV ou algo semelhante;
• Nome do produto: Conforme informado anteriormente, deve seguir o mesmo nome que está cadastrado na aplicação da CDN TV. Para testes em geral, é solicitado o uso do nome Pacote Completo, mas é necessário confirmar com o suporte da CDN TV antes de preencher;
• Tipo do produto: Neste caso, como o pacote de canais não é um material físico, o tipo de produto será Serviço;
• Controla Estoque: Visto que o produto em questão é um bem não material, não é possível controlar estoque, portanto ele será definido como não;
• Movimentação: Pode ser definida conforme sua necessidade, normalmente para produtos de integração ela é definida como venda;
• Unidade Padrão: Para esse tipo de produto utilizamos a unidade ID 13 - SER;
• Preço Base: Deve ser definido conforme a necessidade interna do provedor.

5. Feito isso, temos mais alguns campos com preenchimento obrigatório na Aba Planejamento, sendo eles a Tributação e a Classificação fiscal de saída. Ambos os campos ficam a critério da forma de organização interna do seu provedor.
6. Após concluir o preenchimento de todos os campos obrigatórios, clique em Salvar para concluir o cadastro do produto.

Passo 3: Vínculo do produto no cliente

Atualmente, temos disponíveis três formas de cadastro dos produtos da CDN TV no IXC, sendo elas:

A. Produto com vínculo no PlanoB. Produto com vínculo no ContratoC. Serviços Adicionais

Uma vez definida a forma de cadastro a ser utilizada, é necessário seguir sempre o mesmo padrão para que as validações da aplicação ocorram corretamente. Verifique, abaixo, as orientações para cada forma de cadastro:

A. Produto com vínculo no Plano

Para associar um produto no contrato com vínculo no plano de vendas, temos que adicioná-lo ao plano do cliente. Após o produto ser adicionado no plano de vendas, todos os contratos com esse plano terão o produto incluído automaticamente. Para realizar o procedimento de adição do produto no plano de vendas do contrato do cliente, percorremos o seguinte caminho:

1. Acesse o menu Sistema > Cadstros > pasta Contratos.

2. Em seguida, selecione a opção Planos de Venda.

3. Na página dos planos de venda, clique em Editar.

4. Ao editar o Plano, temos a opção de duplicá-lo para criar um clone específico para o combo do produto, ou podemos seguir diretamente a aba Planos para adicionar o produto da integração.

5. Na Aba Planos, clicamos em Novo e selecionamos:

• Tipo de produto: Seguimos o padrão definido anteriormente no produto, selecionando o tipo Serviços, SVA ou TV.
• Produto/Serviço: Selecionamos o produto criado anteriormente.
• Quantidade: Quantidade do produto a ser cobrada no plano, normalmente será definido como 1.
• Valor unitário: Deve ser definido conforme as regras/necessidades internas do provedor.

6. Clique em Salvar para validar as modificações. Ao salvar novamente, já temos o produto adicionado ao plano e no contrato dos clientes que possuírem esse plano associado.

B. Produto com vínculo no Contrato

Para associar um produto com vínculo diretamente no contrato do cliente, temos que adicioná-lo ao contrato em questão. Nesta forma de cadastro, o produto deve ser adicionado individualmente a cada um dos contratos que deverão ter a integração. Para realizar o procedimento de adição do produto no contrato do cliente, percorremos o seguinte caminho:

7. Acesse o menu Sistema > Cadastros > Contratos.
8. Na grid de contratos, selecione um contrato e clique em Editar.
9. Siga até a aba Produtos.
10. Na Aba produtos, clique em Novo e preencha os campos:

• Tipo de produto: Seguimos o padrão definido anteriormente no produto, selecionando o tipo Serviços, SVA ou TV.
• Produto/Serviço: Selecionamos o produto criado anteriormente.
• Quantidade: Quantidade do produto a ser cobrada no plano, normalmente será definido como 1.
• Valor unitário: Deve ser definido conforme as regras/necessidades internas do provedor.

11. Clique em Salvar para concluir a ação. Após salvar, teremos o produto cadastrado unicamente dentro deste contrato com o vínculo diretamente no contrato.

C. Serviços Adicionais

Para associar um produto como serviço adicional no contrato do cliente, temos que adicioná-lo ao contrato em questão. Nesta forma de cadastro, assim como na anterior, o produto deve ser adicionado individualmente a cada um dos contratos que deverão ter a integração. Para realizar o procedimento de adição do produto como serviço adicional no contrato do cliente, percorremos o seguinte caminho:

12. Acesse o menu Sistema > Cadastros > Contratos.
13. Na grid de contratos, selecione um contrato e clique em Editar.
14. Localize e siga até a aba Serviços adicionais.
15. Na aba serviços adicionais, clique em Novo e preencha os campos:

• Tipo: Seguimos o padrão definido anteriormente no produto, selecionando o tipo Serviços, SVA ou TV.
• Produto: Selecionamos o produto criado anteriormente.
• Descrição: Preenchida automaticamente com o nome do produto.
• Data: A data de inclusão do produto no contrato.
• Unidade: Para esse tipo de produto utilizamos a unidade ID 13 - SER, que será preenchida automaticamente conforme o produto que inserimos.
• Quantidade: Quantidade do produto a ser cobrada no contrato do cliente, normalmente será definido como 1.
• Valor unitário: Deve ser definido conforme as regras/necessidades internas do provedor;
• Repetir: Define se o serviço vai ser repetido pela quantidade inserida no campo repetir quantidade ou se será repetido para sempre. Caso o produto deva ser inserido definitivamente no contrato, selecionamos a opção sempre.

16. Clique em Salvar para concluir as alterações. Após salvar, teremos o serviço adicional vinculado no contrato do cliente.

Passo 4: Como localizar o login do cliente

A CDN TV disponibiliza duas formas de autenticação para o cliente, sendo elas:

A. Login HotsiteB. Login PPPoE

Assim como no produto, uma vez definido, todos os clientes terão que seguir o mesmo padrão, isso é, eles autenticarão somente da forma definida. Verifique, abaixo, as orientações para cada forma de autenticação:

A. Login Hotsite

Para localizar o login Hotsite do cliente, acesse o seguinte caminho:

17. Acesse menu Sistema > Cadastros > Clientes.
18. Selecione um cliente e clique em Editar.
19. Siga até a aba Contato > seção Central do Assinante.
20. Os campos correspondentes são: Login e Senha.

B. Login PPPoE

Para localizar o login PPPoE do cliente, percorremos o seguinte caminho:

21. Acesse menu Sistema > Cadastros > Contratos.
22. Na página dos contratos, clique em Editar.
23. Na página de edição do contrato, localize e clique na aba Login.

Fluxo de Trabalho

Considerações Finais

Para uma integração bem-sucedida entre IXC Provedor e CDN TV, a precisão no cadastro do produto e a uniformidade nos métodos de vínculo e tipo de login são cruciais. Aderir rigorosamente a um padrão definido desde o início previne inconsistências e assegura a validação contínua dos dados, otimizando a operação e o suporte futuro.

Leia Também

• Usuários
• Grupo de Usuários
• Permissões - Grupo de Usuários