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

# início rápido

> comece a usar nossa API em minutos

## comece em três passos

integre com nossa API do dashboard backend e faça sua primeira requisição.

### passo 1: obtenha suas credenciais

<AccordionGroup>
  <Accordion icon="key" title="gere seu token JWT">
    para acessar endpoints protegidos, você precisará de um token JWT válido.

    faça uma requisição para o endpoint de login:

    ```bash theme={null}
    curl -X POST https://backend.testeswaffle.org/auth/login \
      -H "Content-Type: application/json" \
      -d '{"email": "seu@email.com", "password": "sua_senha"}'
    ```

    <Tip>guarde o token retornado - você precisará dele para requisições autenticadas.</Tip>
  </Accordion>

  <Accordion icon="test-tube" title="teste um endpoint público">
    primeiro, teste um endpoint que não requer autenticação:

    ```bash theme={null}
    curl https://backend.testeswaffle.org/referrals/count
    ```

    se retornar dados JSON, a API está funcionando!
  </Accordion>
</AccordionGroup>

### passo 2: faça sua primeira requisição autenticada

<AccordionGroup>
  <Accordion icon="shield" title="use seu token JWT">
    agora teste um endpoint que requer autenticação usando o token obtido:

    ```bash theme={null}
    curl -H "Authorization: Bearer SEU_JWT_TOKEN" \
         https://backend.testeswaffle.org/referrals
    ```

    <Warning>substitua `SEU_JWT_TOKEN` pelo token real retornado no passo anterior.</Warning>
  </Accordion>

  <Accordion icon="database" title="explore os dados">
    nossa API gerencia múltiplos tipos de dados:

    * **referrals**: sistema de indicações
    * **streaks**: gamificação de leitura
    * **metrics**: métricas de ads
    * **newsletters**: gestão de cadernos
    * **forms**: formulários dinâmicos

    <Tip>comece explorando os endpoints de referrals - são os mais utilizados!</Tip>
  </Accordion>
</AccordionGroup>

### passo 3: integre com sua aplicação

<Accordion icon="rocket" title="implemente em sua aplicação">
  agora você pode integrar nossa API em qualquer linguagem:

  **JavaScript/Node.js:**

  ```javascript theme={null}
  const response = await fetch('https://backend.testeswaffle.org/referrals', {
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    }
  });
  const data = await response.json();
  ```

  **Python:**

  ```python theme={null}
  import requests

  headers = {
      'Authorization': f'Bearer {token}',
      'Content-Type': 'application/json'
  }
  response = requests.get('https://backend.testeswaffle.org/referrals', headers=headers)
  data = response.json()
  ```
</Accordion>

## próximos passos 🎯

agora que você já fez sua primeira requisição, explore nossas principais funcionalidades:

<CardGroup cols={2}>
  <Card title="sistema de referrals" icon="users" href="/api-reference/referrals/introduction">
    implemente indicações com anti-fraude e gamificação.
  </Card>

  <Card title="gamificação de leitura" icon="fire" href="/api-reference/streaks/introduction">
    adicione streaks, missões e rankings aos seus usuários.
  </Card>

  <Card title="métricas de ads" icon="chart-bar" href="/api-reference/introduction">
    acesse dados unificados do Facebook, TikTok e Google Ads.
  </Card>

  <Card title="gestão de newsletters" icon="newspaper" href="/api-reference/introduction">
    gerencie múltiplos cadernos e subscribers.
  </Card>
</CardGroup>

## exemplos práticos 💡

<CardGroup cols={2}>
  <Card title="dashboard de indicações" icon="dashboard">
    ```javascript theme={null}
    // buscar indicações do usuário
    const referrals = await api.get('/referrals', {
      params: { email: 'user@email.com' }
    });
    ```
  </Card>

  <Card title="ranking de streaks" icon="trophy">
    ```javascript theme={null}
    // obter ranking de leitores
    const ranking = await api.get('/streaks/ranking');
    ```
  </Card>
</CardGroup>

<Note>
  **precisa de ajuda?** 🤝 veja nossa [documentação completa](/api-reference/introduction) ou nos contate via [suporte](mailto:suporte@thenews.cc).
</Note>