Integração Cariap V2 - Guia de Uso
1. Introdução
O que é a Cariap?
Cariap é uma empresa brasileira do setor de telecomunicações que oferece Serviços de Valor Adicionado (SVAs) para provedores de internet (ISPs).
A empresa disponibiliza soluções que os provedores podem oferecer aos seus assinantes como serviços adicionais ao plano de internet, ajudando a agregar valor aos planos e aumentar a fidelização dos clientes.
Entre os serviços apresentados pela Cariap estão:
- Streaming: acesso a filmes, séries e TV ao vivo.
- Livros e revistas digitais: bibliotecas e plataformas de leitura.
- Saúde digital: serviços de telessaúde.
Como funciona para um provedor?
Por exemplo, um provedor de internet pode contratar um serviço disponibilizado pela Cariap e oferecê-lo aos seus clientes como um benefício adicional, seja incluído em determinado plano ou comercializado separadamente.
Você pode conhecer as soluções no site oficial: cariap.com.br.
2. Integração no SGP
Para integrar o Cariap no SGP precisamos acessar o seguinte menu:
Nesse ponto, realizamos a integração no SGP, em Tipo será necessário definir como Cariap V2 e em seguida copiar e colar o JSON informado abaixo adicionando o Username e o Password do provedor, fornecidos pela Cariap.
{
"username": "[email protected]",
"password": "senha"
}Modelo de integração funcional
3. Cadastro Inicial – Planos de TV
Para cadastrar os planos no SGP é obrigatório que tenha um grupo de contratos de TV.
A verificação e o cadastro podem ser acessadas conforme as instruções abaixo:
O contrato precisa ser do Grupo TV, ter uma Descrição e estar Disponível.
- Grupo: TV
- Descrição: Nome descritivo do contrato
- Status: Disponível
O Contrato pode ser criado em Branco.
Cadastro de Planos
Após validação/criação do grupo de contrato, devemos seguir para o cadastro do(s) plano(s) no seguinte menu:
Na tela de Cadastro de Plano vamos definir uma Descrição, em Contrato vamos selecionar o Grupo de Contratos de TV e vamos definir os Planos de Contas de Mensalidade e Adesão. As demais configurações ficam a critério do Usuário.
Após definir os dados básicos do plano, acesse a guia Dados Técnicos para concluir a configuração. Essas configurações são essenciais para garantir o correto funcionamento e a integração do plano com a Cariap.
Nesta etapa, siga as instruções abaixo:
- Gateway: selecione o gateway previamente criado para a Cariap.
- Gateway ID: informe o(s) código(s) disponibilizado(s) para o cliente. Basta selecionar os planos contratados.
4. Contrato de Serviço do Cliente
Validação de dados cadastrais: Para permitir a ativação do usuário TV, a plataforma Cariap valida os seguintes dados cadastrais do cliente:
- Nome/Razão social;
- CPF/CNPJ;
- Endereço de e-mail;
- Número de telefone;
Certifique-se de que todos estes dados estão preenchidos no Cadastro do Cliente para que a ativação do usuário SVA seja possível.
A integração, por padrão, utiliza os contatos vinculados ao contrato. Abaixo, segue um exemplo da configuração desses contatos:
Cadastro de Novo Contrato ou Adição de Serviço de Contrato Existente.
Após a criação dos planos podemos realizar o cadastro dos clientes. Para isso, teremos duas opções: cadastrar um novo contrato somente para o serviço de TV ou adicionar o serviço de TV a um contrato já existente.
Para cadastrar um novo contrato devemos acessar o cadastro do cliente, ir na guia Contrato e depois em Cadastrar Contrato/Serviço. Vamos definir o Tipo de Contrato como TV e vamos selecionar o POP do cliente:
Para cadastrar o plano a um contrato já ativo basta clicar no botão Opções e Adicionar Serviço de TV.
Nos Dados do Serviço, vamos definir o Plano de TV. Não é necessário definir login e senha.
5. Funcionalidades Disponíveis
A tabela abaixo descreve os recursos disponíveis por meio da integração com a API da Cariap. Essas funcionalidades podem ser acessadas diretamente pelo sistema e utilizadas conforme as permissões da integração.