Skip to content

Como Conectar uma Franquia no IXC Franquia

Introdução

O IXC Franquia é uma solução desenvolvida para centralizar a gestão de dados provenientes de diferentes sistemas IXC Provedor, permitindo o acompanhamento unificado de cadastros de clientes, contratos, dados financeiros, logins e demais informações relevantes.

Para viabilizar essa gestão integrada, é necessário conectar cada sistema IXC Provedor ao IXC Franquia. A seguir, apresentamos o passo a passo para realizar essa integração e garantir o controle centralizado no IXC Franquia.

Requisitos de Uso

  • Chave do sistema IXC Provedor;
  • Criação de usuário específico para a conexão entre o IXC Provedor e o IXC Franquia.
  • Geração do token API.

Entrega de Valor

  • Gestão centralizada e escalável, permitindo administrar múltiplas unidades do IXC Provedor a partir de uma única interface;
  • Otimização de processos, com redução da necessidade de acesso individualizado a cada sistema;
  • Visão unificada dos dados essenciais da organização.

Como Conectar um Sistema do IXC Provedor com o IXC Franquia

Para conectar um sistema IXC Provedor ao IXC Franquia, é necessário considerar os seguintes requisitos essenciais:

  • Obter a chave do sistema IXC Provedor;
  • Possuir um usuário específico para o Franquia no IXC Provedor;
  • Gerar o token API para conectar os dois sistemas;
  • Realizar a sincronização de dados.

Passo 1: Chave de Instalação

Para obter a chave do sistema IXC Provedor, siga as etapas:

  1. Acesse seu sistema IXC Provedor e clique com o botão direito do mouse sobre o dashboard
  2. Clique na opção Sobre
  3. No campo Chave, copie o ID da chave e salve essa informação
Exemplo de chave

O ID da chave se assemelha com a seguinte informação: IXC12-34567-a890c-12345.

Passo 2: Criação de um Usuário para o IXC Franquia

No IXC Provedor, crie um usuário específico para o Franquia, permitindo que o sistema acesse e importe as informações necessárias.

Atenção

É fundamental que este usuário seja de uso exclusivo para a integração.

  1. Acesse menu Configurações > Usuários > Usuários;

  2. Clique no botão Novo para criar um novo usuário;

  3. Preencha os campos obrigatórios:

    • Grupo: vincule um grupo de usuário com permissão total;
    • Nome: insira um nome de identificação para o usuário API;
    • E-mail: insira um endereço de e-mail para o usuário. O dado pode ser fictício;
    • Senha: insira uma senha de acesso para o usuário. A senha deve corresponder aos critérios de segurança;
    • Status: selecione a opção Ativo;
  4. Siga para a seção API e marque a caixa de seleção do campo Permite acesso a API.

  5. Clique em Salvar. O token API será gerado. Copie-o para utilizar no tópico a seguir.

Passo 3: Cadastro do Sistema no IXC Franquia

Cadastre uma franquia do IXC Provedor no IXC Franquia. Siga as etapas descritas a seguir:

  1. Acesse Sistema > Cadastros > Franquia;

  2. Clique no botão Novo e preencha os campos:

    • Franqueador: clique na lupa e selecione o Franqueador correspondente;
    • Razão social: insira a razão social da franquia;
    • Nome fantasia: informe o nome fantasia da franquia;
    • Tipo pessoa: selecione se é pessoa física ou jurídica;
    • CNPJ: insira o CNPJ da unidade;
    • Regime tributário: marque o regime tributário correspondente utilizado pela franquia;
  3. Siga até a seção Integração IXC Provedor e preencha os campos:

    • Host: insira o domínio do sistema IXC Provedor. Ao final do domínio, insira o sufixo /webservice/v1. A URL deve estar na seguinte estrutura: https://seudominio.com.br/webservice/v1
    • Token: insira o token API gerado no cadastro do usuário API
    • Chave: insira o ID da Chave do sistema IXC Provedor do qual está sendo integrado
  4. Acesse a aba Contato e preencha o campo Telefone

  5. Clique em Salvar para concluir a integração

Sincronização de Dados

A sincronização de dados é essencial para que as informações do IXC Provedor sejam refletidas no IXC Franquia.

  1. Acesse menu Configurações > Rotinas > Rotinas de sincronização. O sistema exibirá uma tela com campos específicos de filtros
  2. No campo ID Franquia, clique na lupa e selecione a franquia cadastrada
  3. Mantenha o campo Tabela como padrão, sem indicar nenhuma tabela específica. Isso garantirá que todas as tabelas serão sincronizadas
  4. O campo Tipo também deve ser mantido como padrão, habilitado como Todos, para que todas as ações realizadas na franquia (IXC Provedor) sejam espelhadas no IXC Franquia
  5. Clique em Sincronizar franquias > Sincronização completa (lenta). O sistema exibirá um relatório com os logs da sincronização
Importante!

Durante a sincronização completa, o sistema sincronizado pode apresentar lentidão temporária, devido ao processo de leitura do banco de dados e cópia para o Franquia.

Fluxo de Trabalho

Considerações Finais

A integração entre o IXC Provedor e o IXC Franquia é um processo fundamental para garantir uma gestão centralizada, segura e eficiente de múltiplas unidades dentro de um mesmo ambiente. Seguindo corretamente todas as etapas, desde a criação do usuário exclusivo até a sincronização de dados, a organização assegura maior controle operacional, padronização de informações e agilidade na tomada de decisões. Esse processo, quando bem implementado, potencializa a escalabilidade do negócio e reforça a confiabilidade na gestão das informações.

Leia Também

Disponibilizado por IXC S.A.