Autenticação

Como autenticar nas diferentes categorias de APIs do SophIA.

Application APIs

Requer um api_access_token gerado em Configurações de Perfil após fazer login na sua conta SophIA. Passe o token no header de todas as requisições:

curl -X GET "https://app.sophia.ai/api/v1/accounts/1/conversations" \
  -H "api_access_token: SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json"

Client APIs

Utiliza inbox_identifier (disponível em Configurações → Configuração nas caixas de entrada do tipo API) e contact_identifier (retornado ao criar um contato).

curl -X POST "https://app.sophia.ai/public/api/v1/inboxes/SEU_INBOX_ID/contacts" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "João Silva",
    "email": "joao@exemplo.com",
    "phone_number": "+5511999990001"
  }'

Platform APIs

Requer um api_access_token gerado por um Platform App, criado no Console Super Admin. Disponível apenas em instalações self-hosted.

curl -X GET "https://app.sophia.ai/api/v1/profile" \
  -H "api_access_token: SEU_PLATFORM_TOKEN" \
  -H "Content-Type: application/json"

Tabela de autenticação por tipo

Como encontrar o domínio da sua instalação

O domínio é a URL que você usa para acessar o painel SophIA no navegador. Exemplos de formatos comuns:

Erros e códigos de status

Referência completa de códigos HTTP retornados pela API SophIA.

Conta

Endpoints para consultar e atualizar detalhes da conta SophIA.

Agentes

Gerencie agentes da conta — listar, adicionar, atualizar e remover.

Contatos

CRUD completo de contatos, busca, filtros e merge.

Conversas

Liste, crie, filtre, altere status e gerencie atribuições de conversas.

Mensagens

Envie, liste, atualize e exclua mensagens em conversas.

Caixas de entrada

Crie e gerencie inboxes, agentes vinculados e agent bots.

Etiquetas

Gerencie etiquetas da conta e associações em contatos e conversas.

Times

Crie e gerencie times e seus agentes.

Respostas rápidas

Gerencie respostas pré-definidas (canned responses) para agilizar o atendimento.

Atributos customizados

Defina campos extras para contatos e conversas.

Automações

Crie e gerencie regras de automação na conta.

Webhooks

Configure notificações em tempo real para eventos da conta.

Relatórios

Obtenha métricas e relatórios de desempenho da conta, agentes e times.

Integrações

Liste e gerencie hooks de integração da conta.

Agent Bots

Gerencie bots de atendimento vinculados à conta.

Perfil

Consulte e atualize o perfil do usuário autenticado.

Logs de auditoria

Acesse registros de auditoria da conta (Enterprise Edition).

Contatos — Client API

Crie e gerencie contatos via Client API para experiências de chat customizadas.

Conversas — Client API

Liste conversas e gerencie status via Client API.

Mensagens — Client API

Envie e liste mensagens em conversas via Client API.

Usuários da conta

Gerencie os usuários vinculados à conta.

Labels de contato

Adicione e liste labels associadas a um contato.

Filtros customizados

Crie e gerencie filtros salvos para conversas.

Help Center

Gerencie portais de base de conhecimento, artigos e categorias.

CSAT

Acesse a página de pesquisa de satisfação (CSAT) de uma conversa.

Kanban / Funil de Vendas

Gerencie funis de vendas, estágios, conversas kanban, tarefas, itens, anexos, mensagens agendadas, logs e propostas.

Integração Sienge

Consulte e gerencie dados de clientes, contratos, parcelas, boletos e documentos via integração com o Sienge.

Integração CV CRM

Consulte leads, clientes, corretores, empreendimentos, unidades, atendimentos e workflows via integração com o CV CRM.

Calendário OAuth

Autentique usuários via Google ou Microsoft OAuth e gerencie eventos de calendário integrados ao SophIA.

Management Dashboard

Acesse métricas e dados consolidados para o painel gerencial da conta (API v2).

Contas — Platform API

Crie e gerencie contas no nível administrativo da instalação.

Usuários — Platform API

Gerencie usuários da instalação via Platform API.

Agent Bots — Platform API

Gerencie agent bots em nível de plataforma.