Skip to main content

Visão Geral

A API do SAC (Sistema de Atendimento ao Cliente) fornece endpoints completos para gerenciar tickets de suporte, mensagens, anexos e respostas rápidas. Esta API permite criar, atualizar, listar e gerenciar todo o fluxo de atendimento ao cliente.

Base URL

https://worker.thenewscc.com

Autenticação

A maioria dos endpoints requer autenticação via JWT token. Endpoints públicos estão claramente indicados.

Headers Obrigatórios

Authorization: Bearer {token}
Content-Type: application/json

Recursos Principais

1. Tickets de Suporte

  • Criar e gerenciar tickets
  • Upload de anexos
  • Sistema de mensagens
  • Tags e categorização
  • Status e priorização

2. Fast Response (IA com OpenAI) 🧠

  • Respostas automáticas inteligentes
  • Análise de contexto e similaridade
  • Processamento em lote
  • Níveis de confiança
  • Integração com email

3. Respostas Rápidas

  • Templates predefinidos
  • Categorias organizadas
  • Contador de uso
  • Gestão de conteúdo

4. Relatórios e Métricas 📊

Sistema completo de relatórios com cache de 2h para análise de performance do SAC.
EndpointDescrição
DashboardMétricas principais e visão geral
DetalhadoRelatório completo com todos os filtros
AgentesPerformance individual dos agentes
IssuesTendências e análise de issues
CohortsAnálise de cohorts de tickets
DistribuiçãoDistribuição por hora/dia/newsletter
ResumoResumo rápido (últimos 30 dias)
ComparativoComparativo entre períodos
Série TemporalEvolução temporal de tickets
ResoluçãoMétricas de tempo de resolução
FiltrosOpções de filtros disponíveis
Todos os endpoints de relatórios utilizam cache KV com TTL de 2 horas para otimização de performance. Veja mais em Relatórios - Visão Geral.

5. Operações em Lote

  • Atualização múltipla de status
  • Exclusão em massa
  • Mensagens em lote
  • Fast Response em massa

Status de Tickets

Os tickets podem ter os seguintes status:
StatusDescrição
openTicket aberto aguardando resposta
in_progressTicket em atendimento
closedTicket fechado/resolvido
deletedTicket excluído (soft delete)

Limites e Restrições

Anexos

  • Tamanho máximo: 10MB por arquivo
  • Tipos permitidos:
    • Imagens: image/jpeg, image/png, image/gif, image/webp
    • Documentos: application/pdf, text/plain
    • Planilhas: text/csv, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Paginação

  • Limite padrão: 10 itens por página
  • Limite máximo: 100 itens por página

Tratamento de Erros

A API retorna erros padronizados no seguinte formato:
{
  "success": false,
  "message": "Descrição do erro",
  "error": "Código do erro (opcional)"
}

Códigos de Status HTTP

CódigoDescrição
200Sucesso
201Criado com sucesso
400Requisição inválida
401Não autorizado
403Acesso negado
404Recurso não encontrado
500Erro interno do servidor

Rate Limiting

A API implementa rate limiting para proteção contra abuso:
  • Limite: 100 requisições por minuto por IP
  • Headers de resposta: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Exemplos de Uso

Criar um Ticket

curl -X POST https://worker.thenewscc.com/support \
  -H "Content-Type: application/json" \
  -d '{
    "main": "Técnico",
    "issue": "Bug no sistema",
    "description": "Descrição detalhada do problema",
    "email": "usuario@exemplo.com"
  }'

Listar Tickets

curl -X GET "https://worker.thenewscc.com/support?status=open&page=1&limit=10" \
  -H "Authorization: Bearer {token}"

Suporte

Para dúvidas ou problemas com a API, entre em contato: