---
title: "API: primeiros passos — Documentação | WordPane Cloud"
url: "https://wordpane.cloud/documentacao/api-primeiros-passos/"
description: "Crie uma credencial, selecione permissões e faça sua primeira consulta. 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: primeiros passos

Crie uma credencial, selecione permissões e faça sua primeira consulta.

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

## Crie a credencial no painel

A API pertence à área do cliente e não substitui o painel de controle de cada servidor. Acesse a conta de trabalho correta e abra Conta → API e integrações → Nova integração. Informe nome e validade, escolha as permissões e selecione os servidores e domínios permitidos.

**Antes de continuar**

Guarde a credencial em um gerenciador de segredos ou variável de ambiente: ela aparece somente uma vez. Nunca a publique em JavaScript do navegador, repositórios ou mensagens. Se houver exposição, revogue-a e gere outra.

## Escolha permissões e recursos

Sem seleção, o grupo de recursos não fica acessível. O acesso continua sujeito às permissões atuais do responsável; remover um colaborador ou reduzir suas permissões afeta as próximas chamadas.

### Permissões e detalhes

**`servers.read`**: Consulta servidores e o estado registrado da instalação.

**`emails.read`**: Consulta domínios e caixas de e-mail autorizados.

**`billing.read`**: Consulta saldo e extrato da conta inteira, não apenas dos recursos selecionados.

**`tickets.read`**: Consulta chamados autorizados. Chamados de serviços também dependem do recurso e da permissão correspondente, como servers.read ou emails.read.

**`tickets.reply`**: Responde chamados pela API; também exige tickets.read.

## Faça a primeira consulta

Defina WORDPANE_API_TOKEN no ambiente, sem colocar a credencial no código. Use HTTPS e Authorization: Bearer. A credencial já identifica a conta; não envie o seletor de conta do painel. O exemplo consulta servidores sem alterar recursos.

### cURL

```
curl --fail-with-body \
-H "Authorization: Bearer $WORDPANE_API_TOKEN" \
-H "Accept: application/json" \
"https://app.wordpane.cloud/api/v1/servers?page=1&per_page=20"
```

## Leia a paginação e as datas

Listagens retornam data e meta. Envie page e per_page: o padrão é 20 e o limite é 100 itens. search aceita até 100 caracteres nas consultas com busca. Datas de recursos são retornadas em UTC. O extrato financeiro informa timezone e possui estrutura própria.

### JSON

```
{
"data": [],
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"total": 0
}
}
```

## Responda sem duplicar mensagens

Use tickets.read e tickets.reply. O chamado deve estar aberto e acessível. Envie reply com até 10.000 caracteres; in_reply_to_id é opcional para citar uma mensagem. Gere um UUID em WORDPANE_REQUEST_ID para cada nova resposta. Em caso de timeout, repita o mesmo corpo com a mesma chave.

### cURL

```
curl --fail-with-body \
-X POST "https://app.wordpane.cloud/api/v1/tickets/$TICKET_ID/messages" \
-H "Authorization: Bearer $WORDPANE_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $WORDPANE_REQUEST_ID" \
--data '{"reply":"Mensagem enviada pela integração."}'
```

**Antes de continuar**

A resposta retorna 201. Reutilizar a chave com outro corpo ou responder um chamado fechado retorna 409. Anexos e reabertura não estão disponíveis.

Atualizado em 17 de outubro de 2026.

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

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