Saltar al contenido principal

​
Casos de Uso

Explora escenarios comunes soportados por la Plantilla de API Gateway:

API como Servicio

Rastrea el uso por cliente para plataformas de API y cobra según el número de llamadas.

Limitación de Tasa

Monitorea patrones de uso de la API e implementa limitación de tasa basada en el uso.

Monitoreo de Rendimiento

Rastrea tiempos de respuesta y tasas de error junto con datos de facturación.

SaaS Multitenant

Factura a los clientes según su consumo de API a través de diferentes endpoints.
Ideal para rastrear el uso de endpoints de API, limitación de tasa e implementar facturación de API basada en el uso.

​
Inicio Rápido

Rastrea llamadas a la API a nivel de gateway con agrupamiento automático para escenarios de alto volumen:
1

Instalar el SDK

npm install @dodopayments/ingestion-blueprints
2

Obtén tus Claves de API

3

Crea un Medidor

Crea un medidor en tu Tablero de Dodo Payments:
  • Nombre del Evento: api_call (o tu nombre preferido)
  • Tipo de Agregación: count para rastrear el número de llamadas
  • Configura propiedades adicionales si rastreas metadatos como tiempos de respuesta, códigos de estado, etc.
4

Rastrear Llamadas a la API

import { Ingestion, trackAPICall } from '@dodopayments/ingestion-blueprints';

const ingestion = new Ingestion({
  apiKey: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode',
  eventName: 'api_call'
});

// Track a single API call
await trackAPICall(ingestion, {
  customerId: 'customer_123',
  metadata: {
    endpoint: '/api/v1/users',
    method: 'GET',
    status_code: 200,
    response_time_ms: 45
  }
});

​
Configuración

​
Configuración de Ingesta

​
apiKey
string
required
Tu clave de API de Dodo Payments del tablero.
​
environment
string
required
Modo de entorno: test_mode o live_mode.
​
eventName
string
required
Nombre del evento que coincide con la configuración de tu medidor.

​
Opciones para Rastrear Llamadas a la API

​
customerId
string
required
El ID del cliente para la atribución de facturación.
​
metadata
object
Metadatos opcionales sobre la llamada a la API como endpoint, método, código de estado, tiempo de respuesta, etc.

​
Configuración de Lotes

​
maxSize
number
Número máximo de eventos antes de la auto-limpieza. Predeterminado: 100.
​
flushInterval
number
Intervalo de auto-limpieza en milisegundos. Predeterminado: 5000 (5 segundos).

​
Mejores Prácticas

Usa Agrupamiento para Alto Volumen: Para aplicaciones que manejan más de 10 solicitudes por segundo, usa createBatch() para reducir la sobrecarga y mejorar el rendimiento.
Siempre Limpia los Lotes: Llama a batch.cleanup() al cerrar la aplicación para limpiar eventos pendientes y prevenir la pérdida de datos.