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

# Visão geral da API do LanderLab

> Saiba como funciona a API REST do LanderLab, como se autenticar e quais recursos você pode gerenciar programaticamente, de landing pages e leads a testes A/B e análises.

A API do LanderLab oferece acesso programático a toda a sua conta. Você pode criar e publicar landers, obter dados de leads, ler análises, gerenciar variantes de teste A/B, configurar integrações e muito mais, tudo via HTTP.

Se você prefere trabalhar em linguagem natural em vez de escrever chamadas de API manualmente, o [servidor MCP](/pt-BR/mcp/overview) conecta seu assistente de IA diretamente ao LanderLab usando a mesma API por trás. Ele faz login com a sua conta do LanderLab, então nenhuma chave de API é necessária.

## URL base

Todas as requisições da API vão para:

```text theme={null}
https://api.landerlab.dev
```

A versão atual da API é a **v2**. Todos os endpoints têm o prefixo `/api/v2/`.

## Autenticação

A API usa autenticação por chave de API. Inclua sua chave no cabeçalho `X-API-Key` em todas as requisições.

```text theme={null}
X-API-Key: ll_live_YOUR_KEY_HERE
```

Sua chave começa com `ll_live_` e está vinculada à sua organização. Todas as requisições ficam restritas à organização à qual a chave pertence, então, na maioria das chamadas, você não precisa informar um ID de organização separadamente.

<Note>
  As chaves de API são exibidas apenas uma vez, no momento da criação. Se você perder a sua, precisará gerar uma nova. Veja [Gerar uma chave de API](/pt-BR/mcp/generate-api-key) para conferir o passo a passo.
</Note>

### Respostas de erro

Todos os endpoints retornam códigos de status HTTP padrão.

| Código | Significado                                                            |
| ------ | ---------------------------------------------------------------------- |
| `200`  | Sucesso                                                                |
| `400`  | Requisição inválida (parâmetros inválidos ou limite do plano atingido) |
| `401`  | Não autorizado (chave de API ausente ou inválida)                      |
| `403`  | Proibido (a chave não tem acesso a este recurso)                       |
| `404`  | Não encontrado                                                         |

As respostas de erro incluem uma string `error` no corpo da resposta com a descrição do problema.

## Grupos de recursos

A API é organizada nos grupos de recursos a seguir. Cada grupo corresponde a uma seção da referência da API.

### Espaços de trabalho

Liste, crie e renomeie espaços de trabalho dentro da sua organização. Os espaços de trabalho são o contêiner de nível mais alto para landers, leads e domínios.

| Endpoint                                                        | Descrição                          |
| --------------------------------------------------------------- | ---------------------------------- |
| `GET /api/v2/organizations/{organizationId}/workspaces/get`     | Lista todos os espaços de trabalho |
| `POST /api/v2/organizations/{organizationId}/workspaces/create` | Cria um espaço de trabalho         |
| `POST /api/v2/workspaces/{workspaceId}/rename`                  | Renomeia um espaço de trabalho     |

### Landers

Gerencie landing pages: liste, crie, renomeie, publique, despublique e exclua. A publicação exige um domínio e um caminho e retornará `400` se os limites do plano forem excedidos ou se o caminho já estiver em uso.

| Endpoint                                               | Descrição                                  |
| ------------------------------------------------------ | ------------------------------------------ |
| `GET /api/v2/workspaces/{workspaceId}/landers/get`     | Lista os landers de um espaço de trabalho  |
| `POST /api/v2/workspaces/{workspaceId}/landers/create` | Cria um lander                             |
| `POST /api/v2/landers/{landerId}/publish`              | Publica um lander                          |
| `POST /api/v2/landers/{landerId}/unpublish`            | Despublica um lander                       |
| `DELETE /api/v2/landers/{landerId}`                    | Exclui um lander e todas as suas variantes |

Excluir um lander remove permanentemente todas as variantes, arquivos e integrações associados.

### Teste A/B (variantes)

Cada lander tem uma ou mais variantes. A variante master (principal) é a que recebe o tráfego quando o teste A/B está desativado. Quando o teste A/B está ativado, o tráfego é dividido entre as variantes de acordo com os pesos que você definir.

| Endpoint                                             | Descrição                             |
| ---------------------------------------------------- | ------------------------------------- |
| `GET /api/v2/landers/{landerId}/variants`            | Lista todas as variantes              |
| `POST /api/v2/variants/{variantId}/clone`            | Clona uma variante                    |
| `POST /api/v2/landers/{landerId}/ab-testing/enable`  | Ativa o teste A/B                     |
| `POST /api/v2/landers/{landerId}/ab-testing/disable` | Desativa o teste A/B                  |
| `POST /api/v2/landers/{landerId}/ab-testing/weights` | Define os pesos da divisão de tráfego |
| `POST /api/v2/variants/{variantId}/set-master`       | Promove uma variante a master         |
| `DELETE /api/v2/variants/{variantId}`                | Exclui uma variante                   |

Não é possível excluir a variante master. Primeiro, promova outra variante a master.

### Editor

Carregue e salve o conteúdo HTML e as configurações de uma variante específica. Ao salvar o HTML, a extração de imagens em base64 e o versionamento são feitos automaticamente.

| Endpoint                                            | Descrição                                                           |
| --------------------------------------------------- | ------------------------------------------------------------------- |
| `GET /api/v2/variants/{variantId}/editor/load`      | Carrega HTML, configurações, formulários e metadados                |
| `POST /api/v2/variants/{variantId}/editor/save`     | Salva o conteúdo HTML                                               |
| `POST /api/v2/variants/{variantId}/editor/settings` | Salva as configurações da variante (integrações, SEO, rastreamento) |

### Leads

Obtenha leads no nível do espaço de trabalho ou da organização. Os leads são paginados e podem ser filtrados por intervalo de datas, status (`complete` ou `partial`), lander e termo de busca. O tamanho máximo de página é de 1000 por requisição.

| Endpoint                                               | Descrição                                  |
| ------------------------------------------------------ | ------------------------------------------ |
| `GET /api/v2/workspaces/{workspaceId}/leads/get`       | Lista os leads de um espaço de trabalho    |
| `GET /api/v2/organizations/{organizationId}/leads/get` | Lista os leads de toda a organização       |
| `GET /api/v2/landers/{landerId}/lead-schema`           | Obtém o JSON Schema dos leads de um lander |
| `POST /api/v2/landers/lead-schema`                     | Obtém o JSON Schema de vários landers      |

Os endpoints de schema de leads retornam um [JSON Schema Draft-07](https://json-schema.org/specification-links#draft-7) que descreve todos os campos possíveis que um lead desse lander pode conter, incluindo campos de formulário, respostas de quiz, campos do sistema e campos de integração.

### Análises

Um único endpoint flexível atende a todas as necessidades de análise. Filtre por espaço de trabalho, lander ou variante. O filtro mais específico prevalece: se você informar `variantIds`, os filtros de espaço de trabalho e de lander serão ignorados.

| Endpoint                                                    | Descrição                                                                  |
| ----------------------------------------------------------- | -------------------------------------------------------------------------- |
| `POST /api/v2/organizations/{organizationId}/analytics/get` | Obtém análises com intervalo de datas, fuso horário e agrupamento opcional |

**Parâmetros obrigatórios:** `startDate`, `endDate`, `timezone` (formato IANA, por exemplo, `America/New_York`).

**Filtros opcionais:** `workspaceIds`, `landerIds`, `variantIds`.

**Agrupar por:** `date`, `lander`, `variant` ou `workspace`. O padrão é `date`.

### Domínios

Liste domínios no nível do espaço de trabalho ou da organização.

| Endpoint                                                 | Descrição                                  |
| -------------------------------------------------------- | ------------------------------------------ |
| `GET /api/v2/workspaces/{workspaceId}/domains/get`       | Lista os domínios de um espaço de trabalho |
| `GET /api/v2/organizations/{organizationId}/domains/get` | Lista todos os domínios da organização     |

### Pastas

Organize landers em pastas dentro de um espaço de trabalho.

| Endpoint                                               | Descrição             |
| ------------------------------------------------------ | --------------------- |
| `GET /api/v2/workspaces/{workspaceId}/folders`         | Lista todas as pastas |
| `POST /api/v2/workspaces/{workspaceId}/folders/create` | Cria uma pasta        |
| `POST /api/v2/folders/{folderId}/rename`               | Renomeia uma pasta    |

### Integrações

Crie e liste integrações no nível da organização e, depois, ative ou desative cada uma por lander. Integrações baseadas em OAuth (Mailchimp, HubSpot, Google Sheets, AWeber) exigem um fluxo OAuth interativo e não podem ser criadas diretamente pela API.

| Endpoint                                                          | Descrição                          |
| ----------------------------------------------------------------- | ---------------------------------- |
| `GET /api/v2/organizations/{organizationId}/integrations`         | Lista todas as integrações         |
| `POST /api/v2/organizations/{organizationId}/integrations/create` | Cria uma integração                |
| `POST /api/v2/lander-integrations/{id}/enable`                    | Ativa uma integração de lander     |
| `POST /api/v2/lander-integrations/{id}/disable`                   | Desativa uma integração de lander  |
| `DELETE /api/v2/lander-integrations/{id}`                         | Remove uma integração de um lander |

## Especificação OpenAPI e documentação interativa

A especificação completa em OpenAPI 3.1 está disponível em:

```text theme={null}
https://backend-v2.landerlab.workers.dev/api/v2/openapi.json
```

A documentação interativa da API (com um testador de requisições integrado) está em:

```text theme={null}
https://api.landerlab.dev/api/v2/docs
```

## Como usar a API com um assistente de IA (MCP)

Se você quer gerenciar sua conta do LanderLab em linguagem natural em vez de escrever chamadas de API, o servidor MCP do LanderLab é construído sobre a mesma API e oferece mais de 30 ferramentas para qualquer assistente de IA compatível com MCP, incluindo Claude, ChatGPT, Cursor e Windsurf.

A URL do servidor MCP é:

```text theme={null}
https://api.landerlab.dev/mcp
```

Ele se autentica por meio de um login no navegador, e não pelo cabeçalho `X-API-Key`, então nenhuma chave de API é necessária. Veja [Conecte assistentes de IA via MCP](/pt-BR/mcp/overview) para conferir as instruções de configuração.
