Terminologias comuns

Glossário de termos comumente empregados no contexto de integrações.

TermoSignificado
Cliente (Customer)Pessoa ou entidade final que recebe a pesquisa. Contém informações como nome, CPF, telefone, e-mail e pode ter identificadores internos e externos.

Atributos:
  • solucx_id: ID interno SoluCX do cliente.
  • client_id: ID externo do cliente.
Unidade (Store)Representa um ponto de atendimento ou uma unidade de negócio (ex.: loja física, clínica, setor, filial de serviço, entre outros). Possui IDs internos e/ou externos.

Atributos:
  • store_id: ID interno SoluCX da unidade.
  • store_integration: ID externo da unidade.
Colaborador (Employee)Funcionário ou parceiro vinculado a uma unidade, que pode estar associado a uma transação ou jornada (ex.: vendedor, atendente, médico, entre outros).

Atributos:
  • employee_id: ID interno SoluCX do colaborador.
  • employee_integration: ID externo do colaborador.
JornadaIdentificador usado para diferenciar fluxos de interação das pesquisas. Exemplo: jornada vendas em lojas, jornada vendas e-commerce.

Atributos:
  • journeyId: ID único da jornada.
  • journeySlug: Identificador textual único (slug).
Transação (Transaction)Define uma ação realizada pelo cliente de modo a atender uma necessidade de negócio. Exemplo: dados de uma venda ou atendimento em consultório.

Atributos:
  • transaction_id: ID único da transação gerado pela SoluCX.
  • external_id: Identificador externo (ex: número da venda, prontuário, registro de atendimento, etc.)
Avaliação (Rating)Resposta dada pelo cliente a uma pesquisa enviada.
Survey (Pesquisa)Formulário de pesquisa enviado ao cliente. Pode ser do tipo Smart Survey (básico) ou Flex Survey (flexível).
Disparo (Dispatch)Ato de enviar as pesquisas parametrizadas na plataforma da SoluCX para o cliente respondente por meio de um canal específico.
Ciclo (Cycle)Define os dias em que ocorrerá o disparo da pesquisa para o cliente.

Canais com ciclo:
  • 1 = E-mail
  • 2 = SMS
  • 4 = URA
  • 7 = WhatsApp
CanalMeio através do qual o cliente é abordado para responder a pesquisa. Exemplos: SMS, E-mail, WhatsApp, etc.
Enriquecimento de Dados (Survey Enrichments)Processo de complementar dados do cliente automaticamente, como telefone, documento, e-mail, data de nascimento, entre outros.
Estorno (Reversed)Cancelamento de uma transação já registrada. A transação permanece no sistema para histórico, mas não entra no cálculo de indicadores/métricas.
Opt-outIndicação de que o cliente não deseja mais receber pesquisas. É um atributo que pode ser marcado no cadastro.
Segurança da API
Esta seção descreve alguns aspectos relacionados a segurança do ambiente e da plataforma SoluCX.