---
title: "API: referência de endpoints — Documentação | WordPane Cloud"
url: "https://wordpane.cloud/documentacao/api-referencia/"
description: "Endpoints, permissões, limites e respostas da API v1. Consulte os passos e orientações para usar o painel WordPane Cloud."
language: "pt-BR"
generatedAt: "2026-10-31T14:05:07.042Z"
contentType: "public-page"
pricingSource: "https://app.wordpane.cloud/api/public/plan-catalog"
---

[Central de documentação](https://wordpane.cloud/documentacao/)

API e integrações

# API: referência de endpoints

Endpoints, permissões, limites e respostas da API v1.

**Documentação técnica da área do cliente**

Os exemplos usam dados fictícios e não executam chamadas nesta página. Nunca informe sua credencial real aqui.

## Consulte os endpoints disponíveis

URL base: https://app.wordpane.cloud/api/v1. A tabela abaixo é gerada a partir da especificação OpenAPI publicada. Os caminhos são relativos à URL base. Abra o contrato atualizado para consultar parâmetros e esquemas de cada operação.

[Abrir OpenAPI 3.1 atualizado](https://app.wordpane.cloud/api/v1/openapi.json)

| Método e caminho | Operação | Permissões |
| --- | --- | --- |
| `GET /servers` | Listar servidores | `servers.read` |
| `GET /email-domains` | Listar domínios | `emails.read` |
| `GET /mailboxes` | Listar caixas de e-mail | `emails.read` |
| `GET /tickets` | Listar chamados | `tickets.read` |
| `GET /servers/{id}` | Detalhes do servidor | `servers.read` |
| `GET /servers/{id}/installation` | Estado registrado da instalação | `servers.read` |
| `GET /email-domains/{id}/mailboxes` | Caixas do domínio | `emails.read` |
| `GET /tickets/{id}` | Detalhes do chamado | `tickets.read` |
| `GET /tickets/{id}/messages` | Mensagens do chamado | `tickets.read` |
| `POST /tickets/{id}/messages` | Responder chamado sem duplicar envios | `tickets.read`    `tickets.reply` |
| `GET /balance` | Saldo da conta inteira em BRL | `billing.read` |
| `GET /ledger` | Extrato da conta inteira | `billing.read` |

## Trate erros e limites

O limite é de 60 chamadas por minuto por credencial, além do limite global por origem. Em 429, respeite Retry-After. Para falhas temporárias, use espera progressiva. X-Request-Id identifica a chamada para o suporte; não envie sua credencial ao pedir ajuda.

### Permissões e detalhes

**`401`**: Credencial inválida, expirada ou revogada.

**`403`**: Permissão insuficiente ou acesso do responsável indisponível.

**`404`**: Recurso inexistente ou fora do acesso autorizado.

**`409`**: Conflito de idempotência ou chamado fechado.

**`422`**: Parâmetros inválidos; confira o campo errors.

**`429`**: Limite atingido; aguarde antes de repetir.

**`500`**: Falha temporária; informe X-Request-Id ao suporte.

## Conheça o escopo da versão

A API v1 oferece consultas e respostas a chamados com autorização específica. Não permite contratar, excluir recursos, efetuar pagamentos, acessar SSH ou obter senhas dos servidores. Instalação é uma consulta ao estado registrado, não um fluxo de métricas ao vivo. Use o OpenAPI como contrato atual.

Atualizado em 17 de outubro de 2026.

[Consultar outros guias](https://wordpane.cloud/documentacao/)

---
Fonte oficial: https://wordpane.cloud/documentacao/api-referencia/
Esta é uma representação da página pública. A data de geração não indica alteração editorial.