> ## 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.

# Introdução

> API para gerenciamento de streaks e leitura de conteúdo

## Visão Geral

A API de Streaks permite gerenciar todo o sistema de gamificação de leitura, incluindo registro de leituras, acompanhamento de sequências (streaks), missões, rankings e recompensas.

## Base URL

```
https://backend.testeswaffle.org
```

## Autenticação

O sistema de streaks possui rotas públicas e autenticadas, dependendo da funcionalidade:

### Rotas Públicas

* Registro de leituras e pixel tracking
* Ranking global de leitores
* Informações básicas de streaks

### Rotas Autenticadas

* Grupos de amigos (criação, gerenciamento, rankings)
* Ranking personalizado com posição do usuário
* Operações administrativas
* Exportação de dados

Para rotas autenticadas, inclua o token JWT no header:

```
Authorization: Bearer <seu-token-jwt>
```

## Conceitos Principais

### Streak

Uma sequência de dias consecutivos em que o usuário leu conteúdo. O streak é resetado se o usuário perder um dia.

### Ice Credits

Sistema de créditos que permite ao usuário "congelar" seu streak por um dia caso não consiga ler.

### Missões

Desafios de manter o streak por determinados períodos (7, 30, 90 dias) com recompensas associadas.

### Rankings

Sistema de competição entre leitores, disponível em dois formatos:

* **Global**: Top 100 leitores com maiores streaks
* **Grupos de Amigos**: Competições privadas entre conhecidos

### Grupos de Amigos

Funcionalidade que permite criar grupos privados para competições de streak entre amigos, família ou colegas.

## Respostas

Todas as respostas da API seguem o formato JSON padrão:

### Sucesso

```json theme={null}
{
  "success": true,
  "message": "Mensagem de sucesso",
  "data": {
    // dados da resposta
  }
}
```

### Erro

```json theme={null}
{
  "success": false,
  "message": "Descrição do erro"
}
```

## Próximos Passos

Explore os endpoints disponíveis na API de Streaks através do menu lateral.