bytes suma el ancho de banda de cada cliente para que puedas facturarlo. El blueprint se incluye en el paquete npm @dodopayments/ingestion-blueprints como trackStreamBytes().
Casos de uso
Stream Blueprint es adecuado para estos escenarios:Video Platforms
Factura a los clientes por el consumo de ancho de banda de video y la calidad de la transmisión.
Music Streaming
Registra el uso de streaming de audio por usuario para los niveles de suscripción.
Live Events
Supervisa el consumo de transmisiones en vivo y cobra por el uso del ancho de banda.
Real-Time Data
Registra la transferencia de datos en tiempo real para aplicaciones de IoT y telemetría.
Úsalo para plataformas de streaming de video y audio, servicios de streaming en vivo y aplicaciones de datos en tiempo real.
Inicio rápido
Para registrar el uso de streaming, instala el paquete, crea un medidor y envía los bytes que consume cada cliente.1
Install the SDK
Instala el paquete Ingestion Blueprints de Dodo Payments:
2
Get Your API Keys
Crea una clave de API de Dodo Payments en Developer → API Keys en el panel de Dodo Payments y guárdala en la variable de entorno
DODO_PAYMENTS_API_KEY. Usa una clave del modo de prueba mientras desarrollas. Una clave del modo de prueba solo funciona con test_mode.3
Create a Meter
En el panel de Dodo Payments, ve a Products → Meters y haz clic en Create Meter. Configura estos campos:
- Meter Name: un nombre descriptivo, como
Stream Bandwidth. - Event Name:
stream_consumptiono un nombre que elijas. Debe coincidir exactamente coneventNameen tu código (distingue entre mayúsculas y minúsculas). - Aggregation Type: Sum, para sumar los bytes transmitidos.
- Over Property:
bytes, para facturar según el uso del ancho de banda. - Measurement Unit: la unidad que se muestra en las facturas, como
bytes.
4
Track Stream Usage
Llama a
trackStreamBytes() con el cliente y la cantidad de bytes consumidos:Configuración
Configuración de ingestión
Pasa estas opciones anew Ingestion():
string
requerido
Tu clave de API de Dodo Payments del panel.
string
Modo de entorno:
test_mode o live_mode. El valor predeterminado es test_mode. En cambio, los SDK de Dodo Payments usan live_mode de forma predeterminada, así que establece live_mode explícitamente en producción.string
requerido
Nombre del evento que coincide con el Event Name de tu medidor (distingue entre mayúsculas y minúsculas).
Opciones de Track Stream Bytes
Pasa estas opciones atrackStreamBytes():
string
requerido
El ID de cliente de Dodo Payments al que se facturará la transmisión, por ejemplo,
cus_123.number
Cantidad de bytes consumidos en la transmisión. Es obligatorio para la facturación basada en el ancho de banda. Si lo omites, el evento no tiene un valor
bytes, pero sigue contabilizándose para un medidor Count.object
Metadatos opcionales sobre la transmisión, como el tipo de transmisión, la calidad o el ID de sesión. Cada valor debe ser una cadena, un número o un booleano.
Prácticas recomendadas
Cada llamada atrackStreamBytes() envía un evento independiente, y un medidor Sum suma los fragmentos.