Com consultar bústies email des de l'API REST d'SWPanel

Com integrar l'endpoint de consulta de bústies email a l'API d'SWPanel

L'API REST d'SWPanel permet automatitzar completament la gestió de serveis de correu electrònic, bústies, comptes mail i configuracions associades des d'aplicacions externes, plataformes SaaS, eines DevOps o integracions empresarials.

Un dels endpoints més útils dins de l'ecosistema email d'SWPanel és l'endpoint de consulta de detall d'una bústia:

GET /v2026/services/{id_service}/mail/mailbox/{email}/

Documentació oficial OpenAPI:

https://api.swpanel.com/v2026/redoc?l=ES#tag/email/paths/~1v2026~1services~1{id_service}~1mail~1mailbox~1{email}~1/get

Repositori oficial GitHub:

https://github.com/swpanel

Aquest endpoint permet recuperar tota la informació associada a un compte de correu concret allotjat dins d'un servei de hosting o correu gestionat des d'SWPanel.

La combinació entre documentació OpenAPI i exemples públics a GitHub facilita enormement el desenvolupament d'automatitzacions avançades relacionades amb correu electrònic.

Què permet aquest endpoint

L'endpoint:

GET /v2026/services/{id_service}/mail/mailbox/{email}/

permet consultar tota la informació associada a una bústia de correu específica.

La consulta es realitza utilitzant:

• L'identificador del servei (id_service)
• L'adreça email completa (email)

Depenent del tipus de servei i configuració, la resposta pot incloure:

• Adreça email
• Estat del compte
• Quota assignada
• Espai utilitzat
• Configuració IMAP
• Configuració POP3
• Configuració SMTP
• Estat operatiu
• Límits configurats
• Informació tècnica de la bústia
• Configuració de seguretat

Aquest endpoint resulta especialment útil en integracions relacionades amb automatització de correu corporatiu i gestió centralitzada de comptes email.

Casos d'ús habituals

Aquest endpoint se sol utilitzar per a:

• Portals de client
• Automatització de hosting
• Integracions ERP
• Eines ITSM
• Dashboards de monitorització
• Auditories de correu
• Sistemes DevOps
• Plataformes SaaS
• Automatització de suport tècnic

Endpoint

GET /v2026/services/{id_service}/mail/mailbox/{email}/

Autenticació

L'API utilitza autenticació Bearer Token.

Capçalera requerida:

Authorization: Bearer TU_TOKEN

Els exemples oficials publicats per SWPanel a GitHub utilitzen aquest mateix model d'autenticació:

https://github.com/swpanel

Paràmetres

Paràmetres de ruta

Exemple CURL

curl --request GET \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  --url https://api.swpanel.com/v2026/services/12345/mail/mailbox/[email protected]/ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
  --header 'Authorization: Bearer TU_TOKEN'

Exemple de resposta JSON

{
  "email": "[email protected]",
  "status": "active",
  "quota": 2048,
  "used": 512,
  "imap": true,
  "pop3": true,
  "smtp": true,
  "created_at": "2026-01-10T10:30:00Z"
}

Relació amb el llistat de bústies

El veritable potencial d'aquest endpoint apareix quan es combina amb endpoints de llistat de comptes de correu.

El flux habitual en integracions empresarials sol ser:

1. Obtenir llistat de bústies
2. Recórrer cada adreça email
3. Consultar detall individual
4. Processar informació
5. Automatitzar operacions

Aquest patró permet construir plataformes completament automatitzades de gestió de correu electrònic.

Automatització de plataformes email

L'API permet construir eines capaces de:

• Auditar bústies
• Detectar comptes inactius
• Controlar quotes
• Supervisar espai utilitzat
• Automatitzar reporting
• Detectar incidències
• Integrar plataformes externes

Això resulta especialment útil en entorns corporatius amb múltiples dominis i centenars o milers de comptes email.

Integració amb plataformes DevOps

Tot i que tradicionalment les APIs de correu s'han orientat exclusivament a administració manual, SWPanel permet integrar operacions email dins de pipelines automatitzats.

Per exemple:

• Provisioning automàtic
• Creació d'entorns
• Automatització d'onboarding
• Gestió multi-tenant
• Integració SaaS
• Automatització IT

SWPanel manté una orientació API-first i DevOps-ready en les seves últimes versions:

https://swpanel.com/ca/changelog

Integració amb GitHub i exemples públics

Un dels grans valors de l'ecosistema SWPanel és la disponibilitat de repositoris públics i exemples oficials a GitHub.

Repositori oficial:

https://github.com/swpanel

Entre els projectes disponibles destaquen:

Aquests repositoris permeten accelerar enormement integracions empresarials i automatitzacions complexes.

Exemple pràctic en Python

import requests

TOKEN = "TU_TOKEN"

SERVICE_ID = 12345

EMAIL = "[email protected]"

url = f"https://api.swpanel.com/v2026/services/{SERVICE_ID}/mail/mailbox/{EMAIL}/"

headers = {
    "Authorization": f"Bearer {TOKEN}"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:

    data = response.json()

    print("Compte:", data["email"])
    print("Estat:", data["status"])
    print("Quota:", data["quota"])

else:

    print("Error:", response.status_code)

Exemple pràctic en PHP

<?php

$token = "TU_TOKEN";

$id_service = 12345;

$email = "[email protected]";

$url = "https://api.swpanel.com/v2026/services/$id_service/mail/mailbox/$email/";

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token"
    ],
]);

$response = curl_exec($curl);

curl_close($curl);

$data = json_decode($response, true);

print_r($data);

Casos d'ús empresarials

Auditoria automàtica de bústies

Permet construir sistemes automàtics capaços de:

• Detectar bústies sense ús
• Revisar quotes
• Detectar comptes saturats
• Supervisar emmagatzematge

Integració amb ERPs

Els sistemes ERP poden:

• Relacionar bústies amb usuaris
• Automatitzar altes i baixes
• Supervisar recursos
• Gestionar incidències

Plataformes SaaS

Les plataformes multi-tenant poden sincronitzar automàticament:

• Usuaris
• Dominis
• Bústies
• Configuració email

Eines ITSM

Les plataformes de suport poden:

• Consultar bústies
• Verificar estats
• Automatitzar incidències
• Validar configuracions

Bones pràctiques recomanades

Emmagatzemar respostes en caché

Quan la informació no canvia constantment és recomanable utilitzar caché:

• Redis
• Memcached
• Caché local

Això redueix latència i càrrega sobre l'API.

Gestionar errors HTTP

Sempre s'han de contemplar respostes com:

Validar estats

No s'ha d'assumir mai que un compte email està operatiu únicament perquè existeixi.

Per exemple:

{
  "status": "active"
}

Seguretat

Recomanacions habituals:

• Rotar tokens periòdicament
• Restringir permisos
• Registrar auditories
• Utilitzar exclusivament HTTPS

Integració amb sistemes de monitorització

L'API permet integrar informació de bústies amb:

• Zabbix
• Grafana
• Prometheus
• Datadog
• Sistemes interns

Això facilita crear dashboards avançats de correu corporatiu.

Automatització completa de correu corporatiu

Un escenari habitual pot consistir en:

1. Obtenir llistat de bústies
2. Consultar detall individual
3. Detectar quotes saturades
4. Generar alertes
5. Sincronitzar ERP
6. Automatitzar reporting
7. Actualitzar dashboards
8. Detectar incidències

Tot això sense intervenció manual.

Arquitectura REST moderna

L'API d'SWPanel segueix una arquitectura REST consistent i preparada per a automatització avançada.

Això facilita:

• Integracions ràpides
• Compatibilitat multi-llenguatge
• Escalabilitat
• Automatització empresarial
• Integracions SaaS
• Plataformes DevOps

L'estructura basada en identificadors únics simplifica enormement qualsevol integració tècnica.

Recursos tècnics i documentació

OpenAPI

https://api.swpanel.com/v2026/redoc

Endpoint documentat

https://api.swpanel.com/v2026/redoc?l=ES#tag/email/paths/~1v2026~1services~1{id_service}~1mail~1mailbox~1{email}~1/get

GitHub oficial

https://github.com/swpanel

Changelog SWPanel

https://swpanel.com/ca/changelog