Plugin SDK
Construye plugins que extienden el admin de Whatalo con aplicaciones iframe de página completa — desde dashboards de analíticas hasta herramientas personalizadas de gestión de pedidos.
¿Qué es un Plugin?
Un plugin de Whatalo es una aplicación web que tú alojas en tu propio servidor. Aparece en la barra lateral del admin como una o más vistas de página completa. Los dueños de tiendas instalan tu plugin desde el marketplace o directamente mediante un enlace privado.
Lo construyes con cualquier framework — la plantilla predeterminada usa React y Vite. La comunicación entre tu plugin y el admin ocurre a través del App Bridge, un protocolo postMessage incluido en @whatalo/plugin-sdk.
Cómo Funciona
┌─────────────────────────────────────────────┐
│ Admin de Whatalo │
│ │
│ Barra lateral → /integrations/tu-plugin │
│ │
│ ┌─────────────────────────────────────┐ │
│ │ iframe del Plugin │ │
│ │ (tu servidor, aislado en sandbox) │ │
│ │ │ │
│ │ ← whatalo:init (handshake) │ │
│ │ whatalo:action → (señal ready) │ │
│ │ ← whatalo:context (datos tienda) │ │
│ │ whatalo:action → (toast, nav...) │ │
│ │ ← whatalo:ack (confirmación) │ │
│ └─────────────────────────────────────┘ │
└─────────────────────────────────────────────┘
↕ REST API (permisos con alcance)
Tu servidor de plugin ↔ datos de la tienda- Construyes una aplicación web y la alojas en tu propia infraestructura
- Whatalo la carga en un iframe con sandbox dentro de la barra lateral del admin
- El App Bridge intercambia mensajes entre tu plugin y el admin
- Tu servidor llama a la REST API de Whatalo usando un token de acceso con permisos limitados
Instalación Rápida
npx create-whatalo-pluginSigue las instrucciones para nombrar tu plugin, luego:
cd mi-plugin
whatalo login
whatalo devAbre el dashboard del admin — tu plugin aparece en la barra lateral de inmediato.
Qué Puedes Construir
| Capacidad | Cómo |
|---|---|
| Páginas de admin personalizadas | adminUI.pages en el manifiesto — cada página es una entrada en la barra lateral |
| Acceso a datos de la tienda | REST API con 15 alcances de permisos (read:orders, write:products, etc.) |
| Eventos en tiempo real | 13 eventos webhook (order.created, product.updated, etc.) |
| Acciones en el admin | App Bridge: notificaciones toast, navegación, modales |
| Facturación | Planes de suscripción con periodos de prueba — monetiza tu plugin |
| Distribución | Privada (tus propias tiendas) o pública mediante revisión en el marketplace |
Secciones del SDK
| Sección | Descripción |
|---|---|
| Inicio Rápido | De cero a un plugin funcionando en menos de 15 minutos |
| Visión General de la Plataforma | Qué es la plataforma de plugins y cómo encaja todo |
| Arquitectura del Plugin | Modelo iframe, protocolo App Bridge, modelo de seguridad |
| Requisitos Previos | Qué necesitas antes de empezar |
| Tu Primer Plugin | Tutorial completo de principio a fin |
| Referencia CLI | Los 14 comandos CLI documentados |
| Configuración | Formato del manifiesto, config TOML, alcances de permisos |
| App Bridge | Hook de contexto, acciones, bridge de facturación |
| Cliente API | REST API — productos, pedidos, clientes, inventario |
| Webhooks | 13 tipos de eventos, verificación, manejo |
| Facturación | Planes de pago, pruebas, gestión de suscripciones |
| Componentes UI | Componentes preconstruidos que coinciden con el lenguaje visual del admin |
| Publicación | Envía para revisión y distribuye |
| Mejores Prácticas | Seguridad, rendimiento, manejo de errores |