API: getting started

Create a credential in the panel

The API belongs to the customer area and does not replace each server control panel. Select the correct workspace and open Account → API and integrations → New integration. Enter a name and validity period, choose permissions and select allowed servers and domains.

Choose permissions and resources

Without a selection, that resource group is not accessible. Access remains subject to the responsible user’s current permissions; removing a member or reducing permissions affects subsequent requests.

Permissions and details

servers.read

Read servers and recorded installation state.

emails.read

Read authorized domains and mailboxes.

billing.read

Read the entire account balance and ledger, not just selected resources.

tickets.read

Read authorized tickets. Service tickets also require the corresponding resource and permission, such as servers.read or emails.read.

tickets.reply

Reply to tickets through the API; also requires tickets.read.

Make your first request

Set WORDPANE_API_TOKEN in your environment without embedding the credential in code. Use HTTPS and Authorization: Bearer. The credential identifies the account; do not send the panel account selector. This example reads servers without modifying resources.

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"

Read pagination and timestamps

Lists return data and meta. Send page and per_page: the default is 20 and the limit is 100 items. search accepts up to 100 characters on searchable queries. Resource timestamps are returned in UTC. The financial ledger provides timezone and uses its own structure.

JSON

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

Reply without duplicate messages

Use tickets.read and tickets.reply. The ticket must be open and accessible. Send reply with up to 10,000 characters; in_reply_to_id is optional to quote a message. Generate a UUID in WORDPANE_REQUEST_ID for each new reply. After a timeout, retry the same body with the same key.

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."}'