Configurações Toolbox Digital
Integração
Toolbox Digital: Empresa de plataforma de integração referente à TV e vídeos.
Serviços
Noggin: Serviço de streaming que contempla canal e aplicativo de vídeos e programas televisivos infantis.
Paramount Plus: Serviço de streaming que contempla séries e programas de TV.
Objetivo da documentação
Explicar sobre os parâmetros necessários para a integração com os serviços da Toolbox Digital.
Passo a passo
Como acessar as configurações
1. Acesse as configurações na rotina Suíte / Configurações / Parâmetros como usuário Voalle;
2. Vá ao menu Service Desk;
3. Marque a opção Utiliza Streaming como Sim e salve a página;
4. Agora, acesse a seção Configurações Streaming - Toolbox Digital que apareceu após concluir o passo anterior e termine a parametrização.
Parâmetros
- Tem integração: Este parâmetro habilita os campos relacionados a Toolbox Digital no cadastro de Serviços.
- Token de integração: Este parâmetro deve ser preenchido com o Token gerado pela Voalle e que a Toolbox informará em cada tentativa de autenticação, no header da requisição. A Voalle deve gerar um token do tipo UUID version 4. Não utilize os traços, apenas números e letras. Exemplo: "c45a9601-21d6-463e-9867-769116fec092" vai virar "c45a960121d6463e9867769116fec092".
Cadastrar o serviço
O detalhamento do uso dessa rotina pode ser verificado na documentação Toolbox Digital.
Enviar informações da integração para Toolbox Digital
Envie as informações que a Toolbox utilizará na integração para o cliente repassar a ToolBox Digital: URL do portal, códigos de integração do serviço noggin e paramount plus e token gerado inserido nos parâmetros do ERPVoalle
Explicação
São dois endpoints usados na integração com a Toolbox, onde a Toolbox vai chamar uma API da Voalle similar a API Passiva de outras integrações. Ambos endpoints chamam a mesma base do portal do assinante do provedor.
Endpoint de autenticação:
curl --location --request GET '{URL_PORTAL}/api/ToolboxDigital/authentication?username={USUARIO_PORTAL}&password={SENHA_PORTAL}' \
--header 'Authorization: {TOKEN}'
Endpoint de autorização:
curl --location --request GET '{URL_PORTAL}/api/ToolboxDigital/authorization?subscriber_id={SUBSCRIBER_ID}&country_code=BR&resource_id={CODIGO_INTEGRACAO}&action_id=VIEW&ip_address=0.0.0.0' \
--header 'authorization: {TOKEN}' \
--header 'content-type: application/x-www-form-urlencoded'
Descrição das variáveis
{URL_PORTAL}: URL do portal do assinante do provedor, composto do protocolo, subdomínio e domínio. Exemplo: https://portal.empresa.com.br. Esse é o portal padrão disponibilizado aos provedores atendidos pelo ERPVoalle. Caso ele utilize um portal próprio desenvolvido por outra empresa, favor consultar a equipe de integrações da Voalle Technology.
{USUARIO_PORTAL}: usuário que o cliente com o serviço no contrato usa para acessar o portal do assinante do provedor. Pode ser criado na rotina Suíte / Utilitários / Portal - Usuários do ERPVoalle.
{SENHA_PORTAL}: senha que o cliente com o serviço no contrato usa para acessar o portal. Pode ser criada ou editada na rotina Suíte / Utilitários / Portal - Usuários do ERPVoalle.
{TOKEN}: token gerado pela Voalle, do tipo UUID version 4, e enviado ao integrador Toolbox para uso nas requisições aos endpoints.
{SUBSCRIBER_ID}: identificação do cliente vinda na resposta dada por uma requisição feita ao endpoint de autenticação, mediante o uso de um usuário e senha válidos.
{CODIGO_INTEGRACAO}: código de integração dos serviços disponibilizados pela integração:
- Noggin= urn:tve:noggin
- Paramount Plus= urn:tve:paramountplus
Com exceção do {SUBSCRIBER_ID} que vai ser dado na resposta da primeira requisição, e o {USUARIO_PORTAL} e {SENHA_PORTAL} que vai ser dado pelo cliente quando ele tentar fazer o acesso na plataforma, os demais dados devem ser dados ao provedor, que vai repassá-los a Toolbox Digital.
Exemplo de dados enviados para a Toolbox (devem ser substituídos para cada provedor):
{URL_PORTAL}: https://portal.provedor.com.br
{TOKEN}: fb6727068dia8io59175188c72c000ed7
{CODIGOS_INTEGRACAO}:
Exemplo das requisições utilizando o provedor do exemplo:
curl --location --request GET 'https://portal.provedor.com.br/api/ToolboxDigital/authentication?username={USUARIO_PORTAL}&password={SENHA_PORTAL}' \
--header 'authorization: fb6727068dia8io59175188c72c000ed7
curl --location --request GET 'https://portal.provedor.com.br/api/ToolboxDigital/authorization?subscriber_id={SUBSCRIBER_ID}&country_code=BR&resource_id=urn:tve:noggin&action_id=VIEW&ip_address=0.0.0.0' \
--header 'authorization: fb6727068dia8io59175188c72c000ed7' \
--header 'content-type: application/x-www-form-urlencoded'
Lembrando que o provedor precisa fazer o cadastro dos serviços e incluí-los nos contratos dos clientes. Se a toolbox precisar de um usuário e senha de um cliente de teste, deve ser disponibilizado do cliente que possui os serviços da Noggin e Paramount Plus no contrato. Verificar a página Toolbox Digital para instruções sobre o cadastro do serviço e seu uso em contratos.
Rotinas impactadas
Faturamento / Cadastros / Produtos/Serviços > Serviços
Faturamento / Operações / Dashboard - Faturamento > Contratos - Manutenção