> ## 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.

# Blueprint de Armazenamento de Objetos

> Rastreie uploads de arquivos e uso de armazenamento para S3, Google Cloud Storage, Azure Blob e outros serviços de armazenamento de objetos.

## Casos de Uso

Explore cenários comuns suportados pelo Blueprint de Armazenamento de Objetos:

<CardGroup cols={2}>
  <Card title="File Hosting" icon="folder">
    Cobrar clientes com base no uso total de armazenamento e no volume de uploads.
  </Card>

  <Card title="Backup Services" icon="shield">
    Acompanhar uploads de dados de backup e cobrar por GB armazenado.
  </Card>

  <Card title="Media CDN" icon="photo-film">
    Monitorar uploads de mídia e cobrar por armazenamento e largura de banda.
  </Card>

  <Card title="Document Management" icon="file">
    Acompanhar uploads de documentos por cliente para precificação baseada no uso.
  </Card>
</CardGroup>

<Info>
  Perfeito para cobrança com base em uploads de armazenamento, hospedagem de arquivos, uso de CDN ou serviços de backup.
</Info>

## Início Rápido

Rastreie uploads de armazenamento de objetos com bytes consumidos:

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

  <Step title="Get Your API Keys">
    * **Dodo Payments API Key**: Obtenha no [Dodo Payments Dashboard](https://app.dodopayments.com/developer/api-keys)
    * **Storage Provider API Key**: Da AWS S3, Google Cloud Storage, Azure, etc.
  </Step>

  <Step title="Create a Meter">
    Crie um medidor no seu [Dodo Payments Dashboard](https://app.dodopayments.com/):

    * **Event Name**: `object_storage_upload` (ou o nome de sua preferência)
    * **Aggregation Type**: `sum` para rastrear o total de bytes enviados
    * **Over Property**: `bytes` para cobrar com base no tamanho do armazenamento
  </Step>

  <Step title="Track Storage Usage">
    <CodeGroup>
      ```javascript AWS S3 Upload theme={null}
      import { Ingestion, trackObjectStorage } from '@dodopayments/ingestion-blueprints';
      import { S3Client, PutObjectCommand } from '@aws-sdk/client-s3';
      import fs from 'fs';

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

      const s3 = new S3Client({ region: 'us-east-1' });

      // Read the file (example: from disk or request)
      const fileBuffer = fs.readFileSync('./document.pdf');

      // Upload to S3
      const command = new PutObjectCommand({
        Bucket: 'my-bucket',
        Key: 'uploads/document.pdf',
        Body: fileBuffer
      });

      await s3.send(command);

      // Track the upload
      await trackObjectStorage(ingestion, {
        customerId: 'customer_123',
        bytes: fileBuffer.length
      });
      ```

      ```javascript Google Cloud Storage theme={null}
      import { Ingestion, trackObjectStorage } from '@dodopayments/ingestion-blueprints';
      import { Storage } from '@google-cloud/storage';
      import fs from 'fs';

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

      const storage = new Storage();
      const bucket = storage.bucket('my-bucket');

      // Read the file
      const fileBuffer = fs.readFileSync('./image.png');

      // Upload to GCS
      await bucket.file('uploads/image.png').save(fileBuffer);

      // Track the upload
      await trackObjectStorage(ingestion, {
        customerId: 'customer_456',
        bytes: fileBuffer.length,
        metadata: {
          bucket: 'my-bucket',
          key: 'uploads/image.png'
        }
      });
      ```
    </CodeGroup>
  </Step>
</Steps>

## Configuração

### Configuração de Ingestão

<ParamField path="apiKey" type="string" required>
  Sua chave de API do Dodo Payments no painel.
</ParamField>

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

<ParamField path="eventName" type="string" required>
  Nome do evento que corresponde à configuração do seu medidor.
</ParamField>

### Opções de Rastreio de Armazenamento de Objetos

<ParamField path="customerId" type="string" required>
  O ID do cliente para atribuição de cobrança.
</ParamField>

<ParamField path="bytes" type="number">
  Número de bytes enviados. Obrigatório para cobrança com base em bytes.
</ParamField>

<ParamField path="metadata" type="object">
  Metadados opcionais sobre o upload, como nome do bucket, tipo de conteúdo etc.
</ParamField>

## Melhores Práticas

<Tip>
  **Rastrear antes ou depois do upload**: Você pode rastrear o evento antes ou depois do upload real dependendo da sua estratégia de tratamento de erros.
</Tip>

<Warning>
  **Lidar com falhas de upload**: Rastreie apenas uploads bem-sucedidos para evitar cobrar por operações com falha.
</Warning>