API: primeros pasos

Cree la credencial en el panel

La API pertenece al área de clientes y no sustituye al panel de control de cada servidor. Seleccione la cuenta de trabajo correcta y abra Cuenta → API e integraciones → Nueva integración. Indique nombre y validez, elija permisos y seleccione servidores y dominios permitidos.

Elija permisos y recursos

Sin selección, ese grupo de recursos no será accesible. El acceso sigue sujeto a los permisos actuales del responsable; eliminar un colaborador o reducir sus permisos afecta a las siguientes solicitudes.

Permisos y detalles

servers.read

Consultar servidores y el estado registrado de instalación.

emails.read

Consultar dominios y buzones autorizados.

billing.read

Consultar saldo y extracto de toda la cuenta, no solo de los recursos seleccionados.

tickets.read

Consultar tickets autorizados. Los tickets de servicios también requieren el recurso y permiso correspondientes, como servers.read o emails.read.

tickets.reply

Responder tickets mediante la API; también requiere tickets.read.

Haga su primera consulta

Defina WORDPANE_API_TOKEN en el entorno sin incluir la credencial en el código. Use HTTPS y Authorization: Bearer. La credencial identifica la cuenta; no envíe el selector del panel. El ejemplo consulta servidores sin modificar 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"

Lea la paginación y las fechas

Las listas devuelven data y meta. Envíe page y per_page: el valor predeterminado es 20 y el límite es 100 elementos. search acepta hasta 100 caracteres en las consultas con búsqueda. Las fechas se devuelven en UTC. El extracto financiero indica timezone y tiene estructura propia.

JSON

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

Responda sin duplicar mensajes

Use tickets.read y tickets.reply. El ticket debe estar abierto y ser accesible. Envíe reply con hasta 10.000 caracteres; in_reply_to_id es opcional para citar un mensaje. Genere un UUID en WORDPANE_REQUEST_ID para cada respuesta nueva. Tras un timeout, repita el mismo cuerpo con la misma clave.

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