Integrar o MK Auth ao Opa! Suite
Caminho: Opa! Store → MK Auth → Instalar
Visão geral
O app MK Auth conecta o Opa! Suite ao sistema de gestão MK Auth. Com ele, o agente virtual e os atendentes enviam a segunda via de cobrança ao cliente sem sair do Opa! Suite.
Os clientes do MK Auth não são importados de uma vez. O cadastro do cliente é criado no Opa! Suite quando ele informa o CPF/CNPJ no card Autenticação simples do fluxo de comunicação.
Pré-requisitos
- Permissão para visualizar o Opa! Store no seu grupo de permissões.
- Nenhum outro sistema de gestão instalado. O Opa! Suite aceita um app desta categoria por vez.
- Acesso à API do MK Auth: a URL do servidor e as credenciais de API (client ID e client secret gerados no MK Auth). Se não tiver esses dados, peça ao suporte do MK Auth.
- Rotas de API do Opa! Suite no servidor do MK Auth. A integração consulta duas rotas próprias,
clienteOpaetituloOpa, que não vêm no MK Auth padrão:- Os dois arquivos das rotas (
clienteOpa.apietituloOpa.api) são copiados para a pasta/opt/mk-auth/api/do servidor. Peça os arquivos e o apoio do suporte do Opa! Suite para esta etapa. - Depois da cópia, as rotas clienteOpa.api e tituloOpa.api aparecem no MK Auth. Autorize as duas rotas de API no MK Auth.
- Os dois arquivos das rotas (
O Opa! Suite busca o cliente e as cobranças por essas duas rotas. Sem elas, a autenticação e a segunda via falham.
Passo a passo
- Acesse Opa! Store e abra o app MK Auth.
- Clique em Instalar. A janela Instalar MK Auth abre.
- Preencha os campos (todos são obrigatórios):
- URL: IP ou endereço do seu MK Auth, com
http://ouhttps://. Se a porta web for a padrão (80), não precisa informá-la. Se for outra, use o formatohttp://IP:porta. - Usuário: client ID gerado no MK Auth.
- Senha: client secret gerado no MK Auth.
- URL: IP ou endereço do seu MK Auth, com
- Clique em Instalar.
- Na aba Preferências, seção Ferramentas, clique em Editar informações, ative Permitir envio de segunda via de cobrança e clique em Salvar.
- No fluxo de comunicação, adicione o card Autenticação simples antes do recurso de segunda via, para identificar o cliente pelo CPF/CNPJ.
Resultado esperado
Ao instalar, o Opa! Suite abre a tela de ajustes do app na aba Preferências. Na página do app no Opa! Store, o botão Instalar dá lugar a Ver ajustes.
Com a ferramenta ativa, a opção Segunda via da cobrança passa a aparecer no card Integração ERP do fluxo de comunicação e como atalho no atendimento.
Configurações disponíveis
Acesse Opa! Store → MK Auth → Ver ajustes. Em cada seção, clique em Editar informações, faça as alterações e clique em Salvar.
Aba Cadastro
Seção Dados de integração:
| Campo | O que faz |
|---|---|
| URL | Endereço do MK Auth. Obrigatório. |
| Usuário | Client ID da API. Obrigatório. |
| Nova senha | Client secret. Deixe em branco para manter o valor atual. |
Aba Preferências
Seção Preferências:
| Campo | O que faz |
|---|---|
| Permitir autenticar a cliente inativo | Ativo: clientes inativos no MK Auth também podem se autenticar. Vem ativo na instalação. |
| Sempre solicitar autenticação do cliente | Ativo: o agente virtual pede o CPF/CNPJ mesmo quando o contato já está vinculado a um cliente. Vem desativado na instalação. |
| Permitir visualizar e escolher contratos inativos | Ativo: contratos inativos aparecem na lista de contratos para o cliente escolher. Vem ativo na instalação. |
| Tempo máximo de resposta do App | Quanto tempo, em segundos, o Opa! Suite espera a resposta do MK Auth. Padrão e mínimo: 30 segundos. |
Seção Ferramentas:
| Ferramenta | O que libera | Onde usar |
|---|---|---|
| Permitir envio de segunda via de cobrança | Envio da segunda via das cobranças do cliente. | Card Integração ERP e atalho no atendimento |
Todas as ferramentas vêm desativadas na instalação.
Desinstalar o app
- Acesse Opa! Store → MK Auth → Ver ajustes.
- Clique em Desinstalar App.
- Confirme em Desinstalar.
Ao desinstalar, a conexão com o MK Auth é interrompida e todos os recursos da integração são desativados, inclusive nos fluxos que usam o card Integração ERP.
Problemas comuns
| Sintoma | O que verificar |
|---|---|
| A janela mostra URL inválida | Informe o endereço completo, com http:// ou https://. |
| A página do app mostra Um app desta categoria já está instalado | Outro sistema de gestão já está instalado. Desinstale-o antes de instalar o MK Auth. |
| O cliente não é encontrado na autenticação | Confira se as rotas clienteOpa.api e tituloOpa.api estão no servidor e autorizadas no MK Auth. Se o cliente estiver inativo, confira Permitir autenticar a cliente inativo. |
| A opção Segunda via da cobrança não aparece no fluxo | Ative Permitir envio de segunda via de cobrança em Preferências → Ferramentas. |
| Erro ao salvar Tempo máximo de resposta do App | O valor mínimo é 30 segundos. |
Boas práticas
- Crie credenciais de API exclusivas para o Opa! Suite no MK Auth. Assim, fica fácil identificar e revogar o acesso da integração.
- Coloque o card Autenticação simples no início do fluxo, para que os clientes sejam cadastrados no Opa! Suite à medida que entram em contato.
- Aumente o Tempo máximo de resposta do App só se o MK Auth costuma demorar a responder.