> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Plantilla de API Gateway

> Rastrea llamadas a la API y el uso a nivel de gateway para facturación. Perfecto para plataformas de API como servicio con seguimiento de solicitudes de alto volumen.

## Casos de Uso

Explora escenarios comunes soportados por la Plantilla de API Gateway:

<CardGroup cols={2}>
  <Card title="API-as-a-Service" icon="server">
    Realiza el seguimiento del uso por cliente para plataformas API y cobra según el número de llamadas.
  </Card>

  <Card title="Rate Limiting" icon="gauge">
    Supervisa los patrones de uso de la API e implementa limitación de frecuencia basada en el consumo.
  </Card>

  <Card title="Performance Monitoring" icon="chart-line">
    Controla los tiempos de respuesta y las tasas de errores junto con los datos de facturación.
  </Card>

  <Card title="Multi-Tenant SaaS" icon="users">
    Factura a los clientes según su consumo de API en diferentes endpoints.
  </Card>
</CardGroup>

<Info>
  Ideal para rastrear el uso de endpoints de API, limitar la frecuencia e implementar facturación API basada en el uso.
</Info>

## Inicio Rápido

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

<Steps>
  <Step title="Install the SDK">
    ```bash theme={null}
    npm install @dodopayments/ingestion-blueprints
    ```
  </Step>

  <Step title="Get Your API Keys">
    * **Clave de API de Dodo Payments**: Consíguela desde [Dodo Payments Dashboard](https://app.dodopayments.com/developer/api-keys)
  </Step>

  <Step title="Create a Meter">
    Crea un medidor en tu [Dodo Payments Dashboard](https://app.dodopayments.com/):

    * **Nombre del evento**: `api_call` (o el nombre que prefieras)
    * **Tipo de agregación**: `count` para registrar el número de llamadas
    * Configura propiedades adicionales si rastreas metadatos como tiempos de respuesta, códigos de estado, etc.
  </Step>

  <Step title="Track API Calls">
    <CodeGroup>
      ```javascript Single API Call theme={null}
      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
        }
      });
      ```

      ```javascript High-Volume with Batching theme={null}
      import { Ingestion, createBatch } from '@dodopayments/ingestion-blueprints';

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

      // Create batch for high-volume tracking
      const batch = createBatch(ingestion, {
        maxSize: 100,      // Flush after 100 events
        flushInterval: 5000 // Or flush every 5 seconds
      });

      // Add API calls to batch
      batch.add({
        customerId: 'customer_123',
        metadata: {
          endpoint: '/api/v1/products',
          method: 'GET',
          status_code: 200
        }
      });

      // Clean up when done
      await batch.cleanup();
      ```

      ```javascript Express.js Middleware theme={null}
      import express from 'express';
      import { Ingestion, createBatch } from '@dodopayments/ingestion-blueprints';

      const app = express();

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

      const batch = createBatch(ingestion, {
        maxSize: 50,
        flushInterval: 10000
      });

      // Middleware to track all API calls
      app.use((req, res, next) => {
        const startTime = Date.now();
        
        res.on('finish', () => {
          const responseTime = Date.now() - startTime;
          
          batch.add({
            customerId: req.user?.id || 'anonymous',
            metadata: {
              endpoint: req.path,
              method: req.method,
              status_code: res.statusCode,
              response_time_ms: responseTime
            }
          });
        });
        
        next();
      });

      // Cleanup on shutdown
      process.on('SIGTERM', async () => {
        await batch.cleanup();
        process.exit(0);
      });
      ```
    </CodeGroup>
  </Step>
</Steps>

## Configuración

### Configuración de Ingesta

<ParamField path="apiKey" type="string" required>
  Tu clave de API de Dodo Payments desde el panel.
</ParamField>

<ParamField path="environment" type="string" required>
  Modo de entorno: `test_mode` o `live_mode`.
</ParamField>

<ParamField path="eventName" type="string" required>
  Nombre del evento que coincida con la configuración de tu medidor.
</ParamField>

### Opciones para Rastrear Llamadas a la API

<ParamField path="customerId" type="string" required>
  El ID del cliente para atribuir la facturación.
</ParamField>

<ParamField path="metadata" type="object">
  Metadatos opcionales sobre la llamada API como endpoint, método, código de estado, tiempo de respuesta, etc.
</ParamField>

### Configuración de Lotes

<ParamField path="maxSize" type="number">
  Número máximo de eventos antes del vaciado automático. Predeterminado: `100`.
</ParamField>

<ParamField path="flushInterval" type="number">
  Intervalo de vaciado automático en milisegundos. Predeterminado: `5000` (5 segundos).
</ParamField>

## Mejores Prácticas

<Tip>
  **Usa lotes para alto volumen**: Para aplicaciones que manejan más de 10 solicitudes por segundo, utiliza `createBatch()` para reducir la sobrecarga y mejorar el rendimiento.
</Tip>

<Warning>
  **Siempre limpia los lotes**: Llama a `batch.cleanup()` al cerrar la aplicación para vaciar los eventos pendientes y evitar la pérdida de datos.
</Warning>