Documentation Index
Fetch the complete documentation index at: https://docs.thenewscc.com.br/llms.txt
Use this file to discover all available pages before exploring further.
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.
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
- 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.
| Endpoint | Descrição |
|---|
| Dashboard | Métricas principais e visão geral |
| Detalhado | Relatório completo com todos os filtros |
| Agentes | Performance individual dos agentes |
| Issues | Tendências e análise de issues |
| Cohorts | Análise de cohorts de tickets |
| Distribuição | Distribuição por hora/dia/newsletter |
| Resumo | Resumo rápido (últimos 30 dias) |
| Comparativo | Comparativo entre períodos |
| Série Temporal | Evolução temporal de tickets |
| Resolução | Métricas de tempo de resolução |
| Filtros | Opçõ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:
| Status | Descrição |
|---|
open | Ticket aberto aguardando resposta |
in_progress | Ticket em atendimento |
closed | Ticket fechado/resolvido |
deleted | Ticket 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ódigo | Descrição |
|---|
200 | Sucesso |
201 | Criado com sucesso |
400 | Requisição inválida |
401 | Não autorizado |
403 | Acesso negado |
404 | Recurso não encontrado |
500 | Erro 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:
