Ring2All Ecosystem - Postman API Collections

Suite oficial de colecciones de Postman v2.1 y entorno unificado para la integración y pruebas de APIs externas de todo el ecosistema de telecomunicaciones Ring2All Platform.

Haz clic para abrir el Workspace Público Oficial de Ring2All en Postman en tu app o navegador.

📦 Descargas Oficiales y Acceso Directo

Componente de Plataforma	Tipo de Archivo	Descarga Directa (.json)	Acceso en Postman Cloud
Ring2All PBX (Cloud PBX & AI Agents)	Postman Collection v2.1	📥 Descargar JSON	🚀 Abrir en Postman
Ring2All BSS (Convergent Billing & OCS)	Postman Collection v2.1	📥 Descargar JSON	🚀 Abrir en Postman
Ring2All SBC (Session Border Controller)	Postman Collection v2.1	📥 Descargar JSON	🚀 Abrir en Postman
Ring2All Ecosystem Unified	Postman Environment	📥 Descargar Entorno	🚀 Abrir en Postman

💡 Compatibilidad: Todas las colecciones son compatibles con Postman Desktop v10+, Postman Web, Insomnia y herramientas CLI como Newman.

🚀 Inicio Rápido (3 Minutos)

1. Importar en Postman

Abre tu aplicación Postman y haz clic en Import (o presiona Ctrl+O / Cmd+O).
Arrastra los 4 archivos JSON descargados (Ring2All_Unified_Ecosystem.postman_environment.json y las tres colecciones).
Selecciona el entorno activo “Ring2All Ecosystem - 🌐 Unified Lab / Production Env” en el selector superior derecho de Postman.

2. Configuración de Variables de Entorno

El entorno unificado ya viene precargado con los puertos y rutas estándar:

Variable de Entorno	Descripción	Valor por Defecto (Lab)
`pbx_base_url`	Endpoint base API de Ring2All PBX	`http://192.168.10.31/api`
`bss_base_url`	Endpoint base API de Ring2All BSS	`http://192.168.10.33/api`
`sbc_base_url`	Endpoint base API de Ring2All SBC	`http://192.168.10.32/api`
`pbx_api_key`	Clave API empresarial PBX	`ak_live_...`
`bss_api_key`	Clave API empresarial BSS	`b2a_live_...`
`sbc_api_key`	Clave API perimetral SBC	`sbc_live_...`
`tenant_id`	Identificador numérico de Tenant	`1`
`customer_id`	Identificador numérico de Cliente BSS	`1`
`domain_id`	Identificador numérico de Dominio SIP	`1`

3. Encadenamiento Automático de Peticiones (Zero-Touch Testing)

Cada colección incluye scripts de prueba (pm.test / Tests) integrados que se ejecutan automáticamente en Postman tras cada respuesta exitosa:

Captura Automática de Tokens JWT: Al ejecutar POST /auth/login (en PBX, BSS o SBC), el script almacena automáticamente el token en {{jwt_token}}. En el Portal de Cliente BSS (POST /client/auth/login), se captura automáticamente en {{customer_jwt_token}}.
Captura Dinámica de Identificadores Creados: Al crear un recurso (vía POST /customers, POST /telephony/ai-agents, POST /rates, POST /dispatcher, POST /outbound-routes, etc.), el nuevo id o uuid se guarda automáticamente en su variable de entorno correspondiente (customer_id, agent_id, rate_card_id, dispatcher_id, outbound_route_id, carrier_id, sip_account_id, etc.), permitiendo que las peticiones posteriores de actualización (PUT), consulta (GET) y eliminación (DELETE) funcionen inmediatamente sin copiar y pegar manualmente.

🔐 Estándares de Autenticación y Seguridad

Todas las plataformas implementan autenticación empresarial sin estado mediante cabecera HTTP X-API-Key.

1. Autenticación M2M vía API Key (Recomendada)

Para integrar CRMs, ERPs, sistemas de ticketing o bots externos, incluye la cabecera X-API-Key en cada petición HTTP:

GET /api/extensions HTTP/1.1
Host: 192.168.10.31
X-API-Key: ak_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Ring2All PBX: Prefijo ak_... (validado mediante SHA-256 en base de datos ring2all).
Ring2All BSS: Prefijo b2a_... (validado mediante SHA-256 en base de datos ss_billing).
Ring2All SBC: Prefijo sbc_... (validado mediante SHA-256 en base de datos sbc_admin).

2. Autenticación JWT Bearer

Para sesiones web interactivas o aplicaciones móviles de usuario, envía el token JWT emitido por la ruta de login:

Authorization: Bearer eyJhbGciOi...

3. Soporte CORS Universal

Todas las APIs de Ring2All tienen habilitado soporte de preflight OPTIONS con las siguientes cabeceras permitidas:

Content-Type
Authorization
X-API-Key / x-api-key
X-Customer-ID
X-Correlation-ID

📁 Detalle de Colecciones por Plataforma

1. 📞 Ring2All PBX (`Ring2All_PBX_External_API`)

Softswitch Clase 5, PBX en la nube, agentes de voz con IA y centro de contacto multi-tenant.

Módulos incluidos (36 módulos):
1. 🔐 Authentication & Profile: Login con captura automática de JWT, refresh token, /auth/me, gestión de API Keys.
2. 📞 Extensions & Devices: CRUD de extensiones SIP, binding multi-dispositivo, WebRTC softphone.
3. 🎧 Call Center & Queues: Colas de atención, login/logout de agentes, agentes VIP, prioridades.
4. 📱 Call Applications: Grupos de timbrado (Ring Groups), IVR multinivel, conferencias, parking, paging.
5. 🛤️ Trunks & PBX Routing: Gateways SIP, rutas de entrada (Inbound), rutas de salida (Outbound), condiciones de tiempo.
6. 🛡️ Incoming Security & Tools: Listas negras (Blacklist), modificadores Caller ID, listas de PIN, DISA.
7. 📊 CDRs, Recordings & Realtime Calls: Registro de llamadas (CDR), streaming/descarga de grabaciones, canales activos.
8. 🤖 AI Voice Agents & RAG Hub: Agentes de voz en tiempo real OpenAI Realtime, base vectorial RAG, perfiles LLM.
9. 🌐 SBC Connectors & Topology: Monitoreo y sincronización de troncales con Ring2All SBC.
10. 📱 Push Notifications & Mobile Devices: Notificaciones Push APNs/FCM para softphones iOS/Android.
11. ⚡ Realtime Call Control & Channels: Click2Call (/telephony/originate), escucha y whisper (/telephony/spy), y terminación de llamadas activas (/telephony/hangup).
12. 💬 SMS & Messaging: Proveedores SMS, números habilitados, envío masivo y bidireccional.
13. 📠 Fax Server: Envío y recepción de faxes virtuales T.38 / PDF.
14. 🏢 Multi-Tenant & Domains: Administración de tenants, dominios SIP y aislamiento de datos.
15. ⚙️ Settings, Provisioning & System: Plantillas de aprovisionamiento de teléfonos IP, perfiles SIP y salud del sistema.

2. 💳 Ring2All BSS (`Ring2All_BSS_External_API`)

Business Support System, tarificación en tiempo real OCS, facturación convergente y portal de cliente.

Módulos incluidos (14 módulos):
1. 🔐 Authentication & API Keys: Login administrativo con auto-captura de JWT y generación de API Keys b2a_....
2. 👥 Customers Management: Cuentas de clientes corporativos, límites de crédito y saldos.
3. 👤 Customer Self-Care Portal: Login de cliente con auto-captura de customer_jwt_token, consulta de perfil, balance de billetera, historial y recargas vía Stripe.
4. 💳 Prepaid Wallets & Payments: Consulta de saldo en tiempo real, recargas con tarjeta/Stripe y abonos manuales.
5. 📄 Invoices & Automated Billing: Emisión automática de facturas recurrentes, pago en línea y descarga.
6. 📦 Plans, Bundles & Catalog: Planes de suscripción mensual, paquetes de minutos/SMS y catálogo público.
7. 📈 Tariffs & Destination Rates: Tarifarios LCR, costo por prefijo destino y simulación de llamadas.
8. 🔢 DID Phone Numbers & Inventory: Compra de números DID, asignación y enrutamiento a dominios PBX.
9. ⚙️ OCS Rating Engine & Balance Control: Autorización previa de llamadas, reporte de CDRs y desconexión por saldo bajo.
10. 📊 CDRs, MDRs & Realtime Reports: Reportes de llamadas tasadas, mensajes SMS tasados y KPIs de facturación.
11. 🌐 Telecom Nodes Interconnect: Registro y heartbeat de nodos SBC y FreeSWITCH interconectados.
12. 🛡️ Fraud Prevention & Credit Limits: Reglas de prevención de fraude telefónico y alertas de consumo anómalo.
13. 🔌 Accounting & Webhook Endpoints: Webhooks criptográficos HMAC-SHA256 para sincronización con SAP/QuickBooks.
14. 🤖 AI Assistant & Providers: Interfaz Copilot para consultas analíticas de ingresos y configuración de modelos de IA.

3. 🛡️ Ring2All SBC (`Ring2All_SBC_External_API`)

Session Border Controller perimetral, Kamailio 6.1+, balanceo de tráfico, relay de medios RTPEngine y LCR.

Módulos incluidos (11 módulos):
1. 🔐 Authentication & Carrier Keys: Autenticación de operadores, login JWT y claves de API de alta concurrencia.
2. ⚖️ Dispatcher & Load Balancing: Balanceo de carga hacia clusters FreeSWITCH, sets de destinos y sondeo en vivo (AP/IP/DX).
3. 🛤️ Outbound Routing & LCR: Reglas de enrutamiento por menor costo, failover de carriers, grupos de carriers y PBX endpoints.
4. 🏢 SIP Accounts & Domains: Cuentas SIP registrables, suspensión/reactivación, regeneración de claves, dominios e inventario DID.
5. 🔍 SIP Tracing & Visual Ladders: Captura on-demand de trazas SIP, sesiones agrupadas por Call-ID, diagramas Ladder y diagnóstico de fallas con Inteligencia Artificial.
6. 🎙️ RTPEngine Media Relay & QoS: Monitoreo del proxy de medios, ping de sockets, métricas en vivo (MOS, jitter, packet loss) y políticas de alerta.
7. 🛡️ Anti-Flood Pike & IP Firewall: Módulo Pike anti-DoS, bloqueo de IPs, sincronización con Fail2ban, reglas de firewall y GeoIP.
8. 🤖 AI Perimeter Guard: Telemetría perimetral autónoma en tiempo real, análisis forense de IPs sospechosas, mitigación/baneo y listas blancas.
9. 🔒 STIR/SHAKEN Compliance: Certificados X.509 STI-AS/VS, logs de verificación y generación de bloque de configuración Kamailio.
10. 🌐 WebRTC Gateway & Topology: Configuración de listeners WebRTC (WSS), credenciales STUN/TURN y topología activa de llamadas.
11. 🛠️ Kamailio RPC & System Maintenance: Ejecución segura de binrpc vía API, sugerencias de comandos, métricas de uptime y salud de daemons.

📡 Formato Estándar de Respuestas

Todas las APIs retornan un sobre JSON uniforme:

Petición Exitosa (HTTP 200 / 201)

{
  "success": true,
  "data": {
    "id": 101,
    "name": "Acme Support Extension",
    "is_active": true
  },
  "meta": {
    "page": 1,
    "limit": 25,
    "total": 1
  }
}

Error de Validación o Negocio (HTTP 400 / 401 / 403 / 404 / 500)

{
  "success": false,
  "error": "Unauthorized: Invalid, expired, or unauthorized API Key",
  "statusCode": 401
}

🛠️ Script de Automatización y Regeneración

Si se agregan nuevos módulos al backend, la suite completa se puede regenerar automáticamente con:

node scripts/generate_postman_suite.js

Ring2All Platform — High-Performance Carrier-Grade Class 4/5 Telephony & Convergent BSS