URL de Consulta – Citrus.cx

Integração com cliente

Fabiana Nonjah — Mon, 27 May 2024 12:57:00 +0000

27/05/2024

Confira a Tabela de Versionamento

Acesse a tela Integração com cliente (Administração > Configurações Gerais > Integração com cliente > (botão) +Novo).
Preencha o campo obrigatório "Nome" com um nome que defina a integração com o sistema externo. O campo "Descrição" é opcional, e pode ser preenchido com alguma observação referente a esta integração.
No bloco Dados para Autenticação, preencha os seguintes campos:

- Tipo de autenticação: Selecione "Basic Auth" ou "OAuth2".
- Endpoint de autenticação: A URL que permite acesso ao serviço externo.
- Usuário: Para login na autenticação.
- Senha: Para login na autenticação.
- Nome do token: O token de acesso para autenticação.
- Nome enviado no header: Nome a ser enviado com o token no header.
No bloco Dados para consulta, preencha os seguintes campos obrigatórios:

- URL: URL do endpoint que será feita a consulta dos dados.
- Campo do nome: Atributo do "de-para" ao nome dos clientes.
- Campo do código: Atributo do "de-para" ao código dos clientes.
- Campo de referência: Atributo do "de-para" ao campo código.
- Campo de referência para envio: Atributo do "de-para" ao campo código.
Ainda no bloco Dados para consulta, se desejar preencha os seguintes campos opcionais:

- Label do campo código adicional: Atributo do "de-para" à label do código adicional dos clientes.
- Campo código adicional: Atributo do "de-para" ao código adicional dos clientes.
- Telefone: Atributo do "de-para" ao telefone dos clientes.
- Telefone2: Atributo do "de-para" à segunda opção de telefone dos clientes.
- Celular: Atributo do "de-para" ao celular dos clientes.
- Email: Atributo do "de-para" ao email dos clientes.
- Campo de data de nascimento: Atributo do "de-para" à data de nascimento dos clientes.
- Campo que indica se o cliente está ativo: Atributo do "de-para" à indicação de status dos clientes.
- Nome do filtro para consulta no padrão Query search: Nome do filtro de consulta que permite a redução da quantidade de dados mostrados em uma visualização.
- Nome do parâmetro de pesquisa para o campo Nome: Parâmetro de consulta para o campo Nome passado por URL na requisição.
- Nome do parâmetro de pesquisa para o campo Código: Parâmetro de consulta para o campo Código passado por URL na requisição.
- Objeto com os dados: Atributo indicador que o resultado da chamada do serviço vai ser encapsulado por um objeto e recuperado os dados desse parâmetro.
- WebService de detalhamento: Configuração webservice que será utilizado nos modais de pesquisa de cliente para detalhar uma linha do resultado da consulta.
* Caso deseje selecionar opções neste campo, é necessário cadastrar nas seções Webservices principais e/ou Webservices secundários do bloco Outras integrações. Este bloco é exibido após o passo 7.

- Executa ação: Ao habilitar esta flag é possível configurar um botão de ação.
- Método HTTP: Selecione "Get", "Post" ou "Put"
- Nome da ação: Nome exibido no botão de ação.
- Webservice ação: URL do serviço que será chamado na ação.
- Habilitar o preenchimento automático do Tipo de Cliente: Ao habilitar esta flag é exibido o campo Tipo de cliente com as opções já configuradas na plataforma na tela Tipo de Cliente (Administração > Configurações Gerais > Tipo de Cliente).
* Durante a consulta de dados de um cliente na tela Atendimentos, caso não seja identificado na integração ou na base da plataforma, o "Tipo de cliente" é preenchido automaticamente com a opção configurada no campo Tipo de cliente associado a esta flag.
No bloco Configuração para consultas paginadas, preencha os seguintes campos:

- Objeto da paginação: Nome do objeto para paginação.
- Lista de objetos: A lista no retorno da API.
- Qtde. por página: Quantidade a ser exibida por página.
- Qtde. total: Quantidade total de objetos.
- Próxima página: Número de página.
- Página anterior: Número de página.
* Este recurso pode ser visto pelo Atendente na tela Consultar clientes integração (LemonDesk > Consultar clientes integração > (botão) Filtro). Exemplo: na pesquisa pelo campo "Nome".
Clique no botão Salvar e continuar no topo direito da tela.
Após o passo 7, é exibido abaixo do bloco Dados para Autenticação, o bloco Outras integrações com 02 (duas) seções: "Webservices principais" e 'Webservices secundários".
Clique no botão +Novo Webservice

.
É aberto o popup Webservice. Preencha os seguintes campos obrigatórios:

- Nome: O nome da consulta a ser realizada.
- Nome da aba: O nome da consulta a ser realizada.
- URL: URL do Webservice.
- Tipo de visualização: Selecione "Tabela" ou "Campos".
- Ícone: Escolha a imagem para o ícone da ação.

* O campo Descrição e a flag "Secundário" são opcionais. Permite indicar a observação do serviço externo e se será principal ou secundário, respectivamente.
Clique no botão Salvar e continuar do popup.
É exibido no popup o bloco Campos retorno, peencha os seguintes campos obrigatórios:

- Nome: Atributo do campo no serviço externo.
- Label: Nome para o campo na plataforma.
- Tamanho: O tamanho do campo na tela entre "1" e "12".
- Qtde. Máxima de Caracteres: Quantidade de caracteres para este campo.
- Tipo: Escolha o tipo de entrada de dados para o campo.

* Ao selecionar o Tipo "Select" é exibido o campo obrigatório Tipo de select com as opções: "Fixo", "Webservice" ou "Aninhado".
* Ao selecionar a opção "Webservice" é exibido o campo obrigatório Webservice para preenchimento. Ao selecionar a opção "Aninhado" são exibidos os campos obrigatórios Chave e Valor.

* A flag "Ação" e os campos: WebService para ação e Campos a serem atualizados são de preenchimento opcional, caso deseje configurar uma ação para o campo de retorno.
Clique no botão Salvar do bloco para este campo de retorno ser exibido na configuração. Na coluna "Ordem" é possível clicar nas setas e ajustar a ordenação. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 12.
Ainda no popup, abaixo do bloco Campos retorno, se desejar configurar botões de ação e campos para filtro, utilize as abas: Ações e/ou Filtros de pesquisa.
Na aba Ações do popup, preencha os seguintes campos obrigatórios:

- Título: Nome do botão.
- Campo chave: Atributo no serviço externo.
- Tipo de ação: Escolha a ação do botão.
- Ícone: Imagem para o ícone de ação.
- Webservices secundário: O webservice habilitado como secundário.
- Expressão: Utilizada para validar a apresentação da ação. É feita seguindo a regra: CAMPO_COM_INFORMAÇÃO VALIDAÇÃO VALOR_A_SER_COMPARADO.
Clique no botão Salvar da aba para ser exibido ao lado esta configuração. Na coluna "Ordem" é possível clicar nas setas e ajustar a ordenação. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 15.
Na aba Filtros de pesquisa do popup, preencha os seguintes campos obrigatórios:

- Campo: Atributo no serviço externo.
- Label: Nome do campo na plataforma.
- Tamanho: O tamanho do campo na tela entre "1" e "12".
- Tipo: Escolha o tipo de entrada de dados para o campo.

* Ao selecionar o Tipo "Select" é exibido o campo obrigatório Tipo de select com as opções: "Fixo", "Webservice" ou "Aninhado".

* Ao selecionar a opção "Webservice" é exibido o campo obrigatório Webservice para preenchimento. Ao selecionar a opção "Aninhado" são exibidos os campos obrigatórios Chave e Valor.
Clique no botão Salvar da aba para ser exibido ao lado esta configuração. Na coluna "Ordem" é possível clicar nas setas e ajustar a ordenação. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 17.
Clique no botão Salvar no canto inferior direito do popup. O popup será fechado automaticamente.

DICA
Estas configurações realizadas no bloco Outras integrações são exibidas para o Atendente nas seguintes telas:
1. Atendimentos (LemonDesk > Atendimentos > (selecione na listagem) > ícone Integração > clique no (+) da aba).
2. Consultar clientes integração (LemonDesk > Consultar clientes integração > (botão) Filtro > (preencha os dados necessários) > (botão) Pesquisar > (clique no "Nome") > clique no (+) da aba).
Ainda na tela Integração com cliente, role a tela para baixo até o bloco Campos adicionais. Se desejar adicionar campos na plataforma para retorno de outros dados dos clientes, além dos dados principais do bloco Dados para consulta, preencha os seguintes campos obrigatórios:

- Label: Nome do campo na plataforma.
- Chave: Atributo no serviço externo.

* Utilize a flag "Visível na tabela de consulta" se desejar que os dados dos clientes sejam exibidos para os Atendentes nas telas:
1. Atendimentos (LemonDesk > Atendimentos > (selecione na listagem) > Dados do cliente).
2. Consultar clientes integração (LemonDesk > Consultar clientes integração > (botão) Filtro > (preencha os dados necessários) > (botão) Pesquisar).

* Se desejar, marque a flag "Imprimir campo no relatório" para que os dados sejam exibidos na tela Relatórios (Estatísticas > Relatórios).
Clique no botão +Adicionar para serem exibidos abaixo os campos configurados. Na coluna "Ordem" é possível clicar nas setas e ajustar a ordenação. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 20.
Ao final da tela Integração com cliente, no bloco Dados para adicionar ao header da requisição, preencha os seguintes campos obrigatórios:

- Chave: Atributo no serviço externo.
- Valor: Dado a ser enviado a requisição.

* Ao lado, podem ser utilizadas as Tags que serão substituídas por dados do usuário logado no envio da requisição.
Clique no botão Salvar para serem exibidos os dados configurados. Se desejar fazer alguma alteração, clique no ícone Lixeira e repita o passo 22.
Volte ao topo direito da tela, e clique no botão Salvar.

Tabela de Versionamento

Fabiana Nonjah — Mon, 27 May 2024 12:57:00 +0000

27/05/2024

Versão	Última Atualização
2.98.0	27/05/2024

Por esta tabela é possível acompanhar todas as atualizações reportadas em Tutoriais e Manuais.

Nas telas de documentações que exibem a informação “Confira a Tabela de Versionamento”, pressione sobre a mensagem para ser encaminhado para esta tela com todas as versões contempladas. A seguir, basta abrir a versão indicada para acompanhar as atualizações correspondentes.

Pré-requisitos/Permissões

Fabiana Nonjah — Mon, 27 May 2024 12:56:00 +0000

27/05/2024

Confira a Tabela de Versionamento

O Administrador deve possuir permissões de acesso concedidas para o seu Perfil pelos times de Implantação ou Suporte da Smartspace.

O Administrador deve possuir conhecimento técnico do funcionamento da API e dos Webservices externos que deseja integrar, e configurar os dados de: autenticação, consulta, URL e método de requisição.

O Administrador deve verificar o que precisa constar na API para que a plataforma possa consultar com sucesso os dados dos clientes.

* Confira em Configurar API externa à Integração com cliente.

Para configurar Integração com cliente, o Administrador precisa ter as seguintes permissões habilitadas em seu Perfil:

– Administração

– Configurações Gerais

– Consultar clientes integração

– Listar integrações com cliente

– Criar integração com cliente

– Editar integração com cliente

– Excluir integração com cliente

* Confira como configurar Perfis de acesso.

Configurar API externa à Integração com cliente

Fabiana Nonjah — Mon, 27 May 2024 12:13:00 +0000

27/05/2024

Confira a Tabela de Versionamento

Uma das funcionalidades da plataforma é se integrar com uma API externa para buscar dados cadastrais de clientes, o que otimiza o processo de atendimento ao fornecer o maior número de informações possível sobre o cliente.

Nessa integração, a empresa (cliente Smartspace) fornece os dados através de uma API que será lida pela plataforma na tela Integração com cliente (Administração > Configurações Gerais > Integração com cliente > (botão) +Novo). Além de buscar as informações fornecidas pela API, também pode editá-las no sistema externo sem precisar acessá-lo.

Pré-requisitos

As informações necessárias devem ser especificadas utilizando um formato JSON e em protocolo HTTPS.

O path para chamadas deve ser disponibilizado pela empresa incluindo o de autenticação.

Autenticação

A API deve ter um dos seguintes tipos de autenticação:

Basic Auth: Autenticação básica no formato usuário e senha.
OAuth2: Protocolo de autenticação que fornece um access token.

Configuração

É possível detalhar informações sobre o cliente, como: nome, código, data de nascimento, email, telefone, estado civil, RG, CPF, CNPJ, gênero, e outros dados que sejam relevantes para o usuário.

Para que a plataforma o possa ler essas informações os campos devem estar em um array com propriedades de nível um. Se existirem hierarquias mais extensas não é possível resgatar os dados corretamente.

Se for necessário descrever o endereço do cliente por exemplo, os atributos devem ser inseridos na seguinte estrutura:

				
					"enderecoLogradouro": "string", 

"enderecoNumero": "string", 

"enderecoComplemento": "string",

"enderecoBairro": "string", 

"enderecoCidade": "string", 

"enderecoEstado": "string", 

"enderecoCep": "string", 

"enderecoPontoReferencia": "string"

Exemplo de payload com vários campos, incluindo os obrigatórios:

				
					[ 
  { 

     "nome": "JOÃO DA SILVA”, 

     “cpf”: “00000000000”, 

     “data_nascimen”: “00/00/0000”, 

     “crm”: "000000", 

     “email”: “email@email.com”, 

     “telefone”: “00000000000”, 

     “telefone_2”: “00000000000”, 

     “tipo_prestador”: “PESSOA FÍSICA”, 

     “especialidade”: “DERMATOLOGISTA”, 
     
     “endereco_logradouro”: “RUA ENDEREÇO, 100”, 
     
     “endereco_complemento”: “1 A”, 
     
     “endereco_cep”: “00000000”, 
     
     “endereco_bairro” “BAIRRO ENDEREÇO”, 
     
     “endereco_cidade”: “JOAO PESSOA”, 
     
     "endereco_estado”: “PB” 
     
     "pos_graduacao": "SIM”, 
     
     “ativo”: “TRUE” 

  } 
]

Integração com cliente

Fabiana Nonjah — Mon, 27 May 2024 12:12:00 +0000

27/05/2024

Confira a Tabela de Versionamento

A plataforma foi desenvolvida com o conceito de integração com outros sistemas. Um dos pontos chaves para que uma solução de gestão em atendimento omnichannel tenha sucesso é o processo de integração com sistemas externos ERP (Enterprise Resource Planning – Sistema Integrado de Gestão Empresarial). Assim é possível buscar e/ou atualizar informações dos clientes para que se tenha um processo de atendimento com o maior número de informações possíveis.

A plataforma possui a tela Integração com cliente (Administração > Configurações Gerais > Integração com cliente) onde é possível o Administrador configurar serviços externos e o Atendente realizar a busca pelas informações dos clientes na tratativa dos Atendimentos.

O recurso permite cadastrar diversos Webservices. Esta etapa de configuração de integrações é um processo mais técnico onde o Administrador precisa ter os dados da API. Existe o bloco Dados para Autenticação para autorizar a consulta dos dados, e o bloco Dados para consulta para configurar o Webservice principal de dados dos clientes.

Esse Webservice principal é utilizado para que a plataforma consulte os dados do cliente como: “Nome”, “Código”, “CPF”, “Telefone”, “Celular”, e “Email”, e já preencha automaticamente esses campos no registro de um novo atendimento. Em complemento a esses dados principais é possível configurar mais Webservices no bloco Outras integrações.

Dessa forma, o Administrador pode cadastrar todo tipo de serviço de API externa que ele deseje para realizar a busca de dados dos clientes que são atendidos através da plataforma. É um recurso muito importante porque uma das grandes dificuldades das empresas hoje é de manter atualizado o cadastro de seus clientes.

A Integração com cliente facilita a busca de dados em API’s e Webservices externos, com o retorno de informações que os Atendentes utilizam na gestão dos atendimentos. Este processo de integração possibilita que o Atendente, por qualquer tipo de canal de atendimento, consiga atualizar o cadastro dos clientes no sistema externo sem precisar acessá-lo.

URL de Consulta – Citrus.cx

Integração com cliente

Tabela de Versionamento

Pré-requisitos/Permissões

Configurar API externa à Integração com cliente

Pré-requisitos

Autenticação

Configuração

Integração com cliente

Informações reunidas nesta documentação