API Overview
El Perfex CRM SaaS Module incluye una REST API que te permite gestionar tu plataforma SaaS programáticamente. Es útil para:
- Páginas de registro personalizadas - Construye tu propio flujo de registro
- Integraciones de terceros - Conecta con herramientas externas (Zapier, Integromat, apps personalizadas)
- Automatización de facturación - Sincroniza con sistemas de facturación externos
- Monitoring - Construye dashboards y herramientas de monitoreo personalizados
- Mobile apps - Crea interfaces de gestión móviles
Empezar con la API
Paso 1: Activar la API
- Ve a SaaS Management → SuperAdmin Settings
- Haz clic en la pestaña API Settings
- Activa la API ON
- Genera un API token
Paso 2: Authentication
Todas las peticiones a la API requieren autenticación vía Bearer token en el header de la petición:
Authorization: Bearer YOUR_API_TOKEN_HERE
Paso 3: Base URL
Tu URL base de la API es:
https://yoursite.com/api/saas/
Reemplaza yoursite.com con tu dominio real.
Ejemplo rápido
Aquí tienes un ejemplo rápido de creación de un tenant vía la API:
curl -X POST https://yoursite.com/api/saas/tenants \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"company_name": "Acme Corp",
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"plan_id": 1,
"subdomain": "acme"
}'
Response:
{
"success": true,
"tenant_id": 42,
"domain": "acme.yoursite.com",
"message": "Tenant created successfully"
}
Capacidades de la API
| Endpoint Group | Qué puedes hacer |
|---|---|
| Tenants | Crear, leer, actualizar, eliminar tenants |
| Plans | Listar, crear, actualizar planes |
| Subscriptions | Gestionar suscripciones de tenants |
| Usage | Consultar uso y cuotas de tenants |
Para la lista completa de endpoints, consulta la API Reference.
Rate Limiting
La API implementa rate limiting para proteger tu servidor:
- 100 peticiones por minuto por API token
- Los headers de rate limit se incluyen en cada respuesta
Si excedes el rate limit, recibirás una respuesta 429 Too Many Requests.
Buenas prácticas
- Mantén tu API token secreto - Nunca lo expongas en código del cliente o repositorios públicos
- Usa HTTPS - Siempre realiza peticiones a la API sobre HTTPS
- Maneja errores correctamente - Revisa los códigos de estado de respuesta y maneja errores apropiadamente
- Cachea cuando sea posible - No consultes los mismos datos repetidamente; cachea respuestas cuando no cambien a menudo
info
¿Necesitas una integración personalizada? Si la API no cubre tu caso de uso, contáctanos a través de support. Ampliamos constantemente la API según el feedback de los clientes.