> ## Documentation Index
> Fetch the complete documentation index at: https://docs.play2sell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão Geral da API

> Introdução à API REST do SalesOS para integrações e automações programáticas.

# Visão Geral da API

A API REST do SalesOS permite integrar a plataforma com seus sistemas internos, automações e ferramentas de terceiros.

## Informações básicas

| Item          | Valor                            |
| ------------- | -------------------------------- |
| Base URL      | `https://api.play2sell.com`      |
| Protocolo     | HTTPS (obrigatório)              |
| Formato       | JSON                             |
| Autenticação  | Bearer Token (JWT)               |
| Versionamento | Via path (`/v1/`)                |
| Rate Limit    | 100 requisições/minuto por token |

## Autenticação

Todas as requisições à API exigem um token JWT válido no header `Authorization`:

```bash theme={null}
curl -X GET https://api.play2sell.com/v1/leads \
  -H "Authorization: Bearer SEU_TOKEN_JWT" \
  -H "Content-Type: application/json"
```

<Note>
  Consulte o guia de [Autenticação](/pt/api/authentication) para detalhes sobre como obter e renovar tokens.
</Note>

## Endpoints disponíveis

<CardGroup cols={2}>
  <Card title="Leads" icon="user-plus" href="/pt/api/endpoints/leads">
    CRUD completo de leads: criar, listar, atualizar e excluir.
  </Card>

  <Card title="Vendas" icon="chart-line" href="/pt/api/endpoints/sales">
    Gerenciar oportunidades, etapas do pipeline e deals.
  </Card>

  <Card title="Usuários" icon="users" href="/pt/api/endpoints/users">
    Listar e gerenciar usuários e equipes.
  </Card>

  <Card title="Webhooks" icon="globe" href="/pt/api/endpoints/webhooks">
    Configurar webhooks para receber eventos em tempo real.
  </Card>
</CardGroup>

## Padrões da API

### Paginação

Endpoints que retornam listas suportam paginação:

```json theme={null}
{
  "data": [...],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 150,
    "total_pages": 8
  }
}
```

Parâmetros: `?page=1&per_page=20`

### Respostas de erro

Erros seguem um formato padronizado:

```json theme={null}
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "O campo 'email' é obrigatório.",
    "details": [...]
  }
}
```

### Códigos HTTP

| Código | Significado              |
| ------ | ------------------------ |
| 200    | Sucesso                  |
| 201    | Criado com sucesso       |
| 400    | Erro de validação        |
| 401    | Não autenticado          |
| 403    | Sem permissão            |
| 404    | Recurso não encontrado   |
| 429    | Rate limit excedido      |
| 500    | Erro interno do servidor |

### Filtros

Use query parameters para filtrar resultados:

```
GET /v1/leads?status=qualified&created_after=2026-01-01&sort=-created_at
```

* Prefixo `-` indica ordenação decrescente
* Datas no formato ISO 8601

<Tip>
  Use o header `X-Request-ID` para rastrear requisições. Se precisar de suporte, informe o request ID para facilitar a investigação.
</Tip>

<Warning>
  A API está disponível apenas nos planos **Professional** e **Enterprise**. Verifique seu plano em **Configurações > Plano**.
</Warning>

## Integrações

<CardGroup cols={3}>
  <Card title="SalesOS Connect (n8n)" icon="plug" href="/pt/api/integrations/n8n">
    Automações visuais com n8n.
  </Card>

  <Card title="Pagamentos" icon="credit-card" href="/pt/api/integrations/payments">
    API de cobranças, payouts e extrato.
  </Card>

  <Card title="Integrações Custom" icon="puzzle-piece" href="/pt/api/integrations/custom">
    Crie suas próprias integrações.
  </Card>
</CardGroup>