Dados de Integração
URLs
URL do ERP: Trata-se do endereço WEB do ERP onde o integrador irá realizar ou receber requisições. Exemplos:
- Ambiente de produção: https://erp.cliente.com.br
- Ambiente de homologação: https://homologa.cliente.com.br
URL do Portal: Endereço WEB do Portal. Exemplo:
Integração Mapas e Métodos External
*Rotina disponível apenas para usuários do ERP com perfil "Administrador"
Usuário: Usuário criado para o integrador enviar requisições ao ERP, recomenda-se utilizar um usuário para cada integrador. Saiba mais na página Login de Acesso;
Senha: Senha criptografada do usuário selecionado;
SynData: Chave que identifica para qual ambiente a requisição será direcionada (Produção ou Homologação);
Para localizar estas informação o usuário deve:
- Acessar a rotina Suíte / Configurações / Parâmetros > Integração / Mapa > Dados para acesso;
- Copiar as informações completas de cada campo e enviar ao integrador;
PBX
Integrator: Integrator utilizado pela empresa de integração selecionada. Veja na tabela abaixo:
Integrator PBX
| Integração | Integrator |
|---|---|
| Newave | newave |
| NativeIP | native |
| Native Infinity | new |
| Futuro fone | new |
| Matrix | new |
| Caliope | new |
| Telein | native |
| Fortics | new |
Token: Token utilizado para realizar requisições vinculadas ao PBX.
Para localizar este campo o usuário deve:
- Acessar a rotina Suíte / Configurações / Parâmetros > Integração / PBX > Token de Integração;
- Copiar a informação completa deste campo de enviar ao integrador;
Saiba mais nas páginas Configurações PABX
APIs do Portal
*Rotina disponível apenas para usuários do ERP com perfil "Administrador"
Verify Token: Token que contém as informações sobre o servidor do banco de dados onde serão feitas as requisições;
Client Id: Identificador do cliente;
Client Secret: Token utilizado para confirmar que o usuário identificado pelo Client Id é válido;
Usuário e Senha do Portal: Usuário e senha cadastrados para o cliente acessar o portal. Saiba mais em Portal - Usuários;
Estes dados encontram-se na rotina Suíte / Configurações / Parâmetros > App cliente > Configurações de Acesso
API Passiva
Token: Token gerado automaticamente para identificar a integradora cadastrada no ERP;
- Importante: A cada alteração no cadastro da integração, é gerado um novo Token que deve ser enviado para a integradora;
Integrator: Alias / Integrator identificador da empresa de integração cadastrada;
Resource Id: Identificador do serviço cadastrado, saiba mais em Configurações de produtos das APIs passiva e reativa;
Usuário e Senha do Portal: Usuário e senha cadastrados para o cliente acessar o portal. Saiba mais em Portal - Usuários;
Após efetuar o cadastro do integrador na rotina Manutenções / Integrações / Integradores o usuário deve:
- Localizar o cadastro referente a integradora desejada;
- Clicar na linha correspondente e copiar a informação completa do campo Token;
Mais informações acesse a página Configurações para integrações passivas
Dados das Integrações passivas
| Integração | Alias ou Integrator | Cód Integração ou resourceid |
|---|---|---|
| Bittrainers | bittrainers | bittrainers |
| Campsoft - Bancah | bancah | bancah |
| Campsoft - Bebanca | bebanca | bebancajornais |
| Campsoft - Bebanca | bebanca | bebancapremiun |
| Campsoft - Bebanca | bebanca | bebancarevistas |
| Campsoft - Begamer | begamer | begamer |
| Campsoft - Estádio TNT Sports | tntsports | tntsports |
| Campsoft - Guigo TV | guigotv | guigotv |
| Campsoft - HBO Max | hbomax | hbomax |
| Campsoft - Hube | hube | hube |
| Campsoft - Imagina Só | imaginaSo | imaginaSo |
| Campsoft - Rede Parcerias | redeparcerias | urn:sva:redeparcerias |
| Campsoft - Supercomics | supercomics | supercomics |
| Campsoft - Toca Livros | tocalivros | Esta integração possui vários, verifique com a Toca Livros qual deve ser usado |
| Campsoft - Qualifica | mlearn | premium-qualifica |
| Campsoft - Qualifica | mlearn | pro-qualifica |
| Clube Certo | clube | clube |
| DirectvGo Passiva | directvgo-passive | Esta integração possui vários, verifique com a Directv GO qual deve ser usado |
| FB Vest | fbvest | Esta integração possui vários, verifique com a FB Vest qual deve ser usado |
| Neo TV | neotv | Esta integração possui vários, verifique com a Neo TV qual deve ser usado |
| Nubbi - Academia do Provedor | academiadoprovedor | academiadoprovedor |
| Superplayer & Co - Imagina Só | imaginaso | urn:sva:imaginaso |
| Superplayer & Co - Mumo | mumo | urn:sva:mumo |
| Technobox - CDNTV | technobox | Esta integração possui vários, verifique com a Technobox qual deve ser usado |
Note que o "Cód Integração" é um parâmetro que faz o vínculo com o plano que o cliente final pode utilizar.
Exemplo
A Qualifica vende um serviço de cursos chamado MLearn e ela oferece 2 planos: um plano básico, chamado Pro, e um com mais conteúdo, chamado Premium.
- Se um cliente da Voalle quiser oferecer os serviços da Qualifica, ele deve cadastrar dois serviços na rotina "Faturamento / Cadastros / Produtos/Serviços": um serviço com o Cód Integração "pro-qualifica" e outro serviço com o Cód Integração "premium-qualifica".
- Após fazer a venda para o cliente final, o cliente da Voalle vai atribuir ao contrato daquele individuo apenas o serviço contratado - ou o Pro ou o Premium. É possível oferecer ambos, um cliente pode querer fazer um upgrade e contratar o melhor serviço. Nesse caso, a integração da MLearn identifica e dá acesso ao "maior" conteúdo (o plano Premium).
Note também que nesse exemplo de integradores que oferecem mais de um serviço é necessário fazer apenas um cadastro na rotina "Assessoria ao Cliente / Integrações / Integradores". A URL do portal é uma só, o integrator é um só, o token gerado no cadastro dessa rotina é um só também. Neste exemplo da Qualifica utilizando a integração com a empresa "X", a resposta à solicitação de integração ficaria parecida com:
Plano Pró
{{url}}: https://portal.X.com.br
{{integrator}}: mlearn
{{resource_id}} ou Cód Integração: pro-qualifica
{{token}}: ab66c837a8b34c7d979ba52799b9ae75
Plano Premium
{{url}}: https://portal.X.com.br
{{integrator}}: mlearn
{{resource_id}} ou Cód Integração: premium-qualifica
{{token}}: ab66c837a8b34c7d979ba52799b9ae75