Comece por aqui

Bem-vindo à documentação da API SoluCX! Este guia vai te levar do zero até sua primeira integração funcionando em poucos minutos.

O que é a API SoluCX?

A API SoluCX é uma API RESTful que permite integrar a plataforma de gestão de experiência do cliente nos seus sistemas. Com ela você pode:

  • Criar transações que representam interações dos seus clientes com sua empresa
  • Gerenciar clientes, unidades e colaboradores de forma programática
  • Disparar pesquisas automaticamente baseadas em eventos
  • Consultar dados e relatórios de satisfação

URL Base

AmbienteURL
Produçãohttps://api.solucx.com.br/public
Preview (beta)https://api.preview.solucx.com.br/public

Conceitos Fundamentais

Antes de começar, é importante entender os principais conceitos da plataforma:

Transação - Uma transação representa uma interação do cliente com sua empresa. Pode ser uma compra, um atendimento, uma entrega, etc. Cada transação pode disparar uma pesquisa automaticamente.

Jornada - Uma jornada é um tipo de experiência que você quer medir (ex: "pós-compra", "pós-atendimento"). Você configura jornadas no painel SoluCX e referencia elas via journeySlug ao criar transações.

Pesquisa (Survey) - Uma pesquisa é enviada automaticamente ao cliente após uma transação, baseada na jornada configurada. Pode ser NPS, CSAT, CES ou personalizada.

Cliente (Customer) - Representa a pessoa que receberá a pesquisa. Identificado por email, telefone ou ambos.

Unidade (Store) e Colaborador (Employee) - Entidades que permitem segmentar e analisar feedback por unidade de negócio e por atendente. Exemplos de unidades: lojas (varejo), clínicas (saúde), agências (financeiro).

Passo 1: Obtenha suas credenciais de API

Para utilizar a API SoluCX, você precisará de duas chaves de autenticação:

  • x-solucx-api-key: Chave de API da sua instância
  • x-solucx-user-token: Token do usuário para autenticação

Para obter suas credenciais, entre em contato com nosso suporte através do email [email protected].

Passo 2: Faça sua primeira requisição

Teste suas credenciais consultando transações na API:

cURL
JavaScript
Python
curl -X GET 'https://api.solucx.com.br/public/transaction?date_from=2024-01-01&date_to=2024-01-31&limit=1' \
  -H 'x-solucx-api-key: SUA_API_KEY' \
  -H 'x-solucx-user-token: SEU_USER_TOKEN'

Se tudo estiver correto, você receberá uma resposta 200 OK com os dados das transações.

Passo 3: Configure a jornada no painel

Para que a pesquisa seja enviada, configure uma jornada:

  1. Acesse Jornadas no painel SoluCX
  2. Crie ou edite uma jornada com o slug pos-compra (o mesmo que será usado no journeySlug)
  3. Configure qual pesquisa enviar e quando (imediatamente, após 1 dia, etc.)
  4. Ative a jornada

Passo 4: Crie sua primeira transação

Agora vamos criar uma transação que disparará uma pesquisa. Use o endpoint /v2/transactions:

cURL
JavaScript
Python
curl -X POST 'https://public-api.gke-prd.solucx.com.br/v2/transactions' \
  -H 'x-solucx-api-key: SUA_API_KEY' \
  -H 'x-solucx-user-token: SEU_USER_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "transaction": {
    "externalId": "pedido-12345",
    "journeySlug": "pos-compra",
    "experienceDate": "2024-01-15T14:30:00Z"
  },
  "customer": {
    "name": "João Silva",
    "email": "[email protected]",
    "phone": "+5511999998888"
  },
  "store": {
    "externalId": "unidade-sp-centro",
    "name": "Unidade SP Centro"
  },
  "employee": {
    "externalId": "colaborador-123",
    "name": "Maria Santos"
  }
}'

Resposta esperada:

{
  "success": true,
  "data": {
    "id": 12345,
    "externalId": "pedido-12345",
    "status": "pending",
    "createdAt": "2024-01-15T14:30:00Z"
  }
}

Passo 5: Verifique o resultado

Após criar a transação e configurar a jornada:

  • A pesquisa será enviada automaticamente para o cliente via email/SMS
  • Você pode acompanhar os resultados no painel SoluCX nos relatórios NPS e Extrato

Para consultar uma transação específica via API:

cURL
curl -X GET 'https://api.solucx.com.br/public/transaction?transactionId=pedido-12345' \
  -H 'x-solucx-api-key: SUA_API_KEY' \
  -H 'x-solucx-user-token: SEU_USER_TOKEN'

Exemplo de resposta:

{
  "id": "12345",
  "transaction_id": "pedido-12345",
  "external_id": "pedido-12345",
  "aval_complete": true,
  "journey": "pos-compra",
  "rating": {
    "value": "9",
    "source": "email"
  },
  "customer": {
    "name": "João Silva",
    "email": "[email protected]"
  }
}

Próximos Passos

Agora que você criou sua primeira transação, explore outros recursos:

Autenticação e Endpoints

Entenda todos os detalhes sobre autenticação, segurança e explore todos os endpoints disponíveis.

Webhook para Chatbots

Endpoint para receber respostas de pesquisas configuradas em ambientes conversacionais, como chatbots.

SDKs e Integrações

Use nossos SDKs prontos para Flutter, React Native ou Web, e diversas integrações.

Exemplos Práticos

Transação de e-commerce

// Após confirmação de pedido
await criarTransacao({
  externalId: pedido.id,
  journeySlug: 'pos-compra',
  customer: {
    name: pedido.cliente.nome,
    email: pedido.cliente.email,
    phone: pedido.cliente.telefone
  },
  extras: {
    valor_pedido: pedido.valor,
    produtos: pedido.itens.map(i => i.nome).join(', ')
  }
});

Transação de atendimento

// Após fechamento de ticket de suporte
await criarTransacao({
  externalId: ticket.id,
  journeySlug: 'pos-atendimento',
  customer: {
    name: ticket.cliente.nome,
    email: ticket.cliente.email
  },
  employee: {
    externalId: ticket.atendente.id,
    name: ticket.atendente.nome
  },
  extras: {
    categoria: ticket.categoria,
    tempo_resolucao: ticket.tempoResolucao
  }
});

Se tiver dúvidas, entre em contato com nosso suporte através do email [email protected].

Introdução