Mit Ihrer Datenbank synchronisieren

Synchronisieren Sie Ihre Dodo Payments-Daten für Analytics, Reporting und Integrationen mit Ihrer eigenen Datenbank. Die Sync-Engine repliziert Zahlungen, Kunden, Abonnements und Lizenzen automatisch nach MongoDB, PostgreSQL, MySQL oder ClickHouse.

Paket: dodo-sync auf npm | Quelle: GitHub

Was können Sie synchronisieren?

Wählen Sie eine beliebige Kombination dieser Entitäten:

Payments

Alle Zahlungstransaktionen, einschließlich einmaliger Zahlungen, Rückerstattungen und Statusaktualisierungen.

Customers

Kundenprofile, Kontaktinformationen und Metadaten.

Subscriptions

Abonnementdaten, Abrechnungszyklen und Statusänderungen.

Licenses

Lizenzschlüssel, Aktivierungen und Statusaktualisierungen.

Geben Sie über den Parameter scopes an, welche Entitäten synchronisiert werden sollen. Bei jedem Durchlauf wird jeder Datensatz in den ausgewählten Bereichen abgerufen und anhand seiner ID geschrieben, sodass vorhandene Zeilen direkt aktualisiert statt dupliziert werden. Jede Datensatzseite wird in einem einzigen Batch in Ihre Datenbank geschrieben.

Datenbankunterstützung

Dodo Sync unterstützt MongoDB, PostgreSQL, MySQL 8.0.20 oder höher sowie ClickHouse. Die Unterstützung für Snowflake und andere Datenbanken, ETL-Pipelines und die Echtzeit-Synchronisierung befindet sich in Entwicklung. Um eine neue Datenbankintegration beizusteuern, reichen Sie einen Pull Request im GitHub-Repository ein.

Erste Schritte

Verwenden Sie Dodo Sync für eine schnelle Einrichtung über die CLI oder programmatisch in Ihrem Code, um es in Ihre Anwendung zu integrieren. Beide Methoden bieten dieselbe Funktionalität.

Verwendung der CLI

Installieren Sie die CLI global, um sie von überall ausführen zu können:

npm install -g dodo-sync

bun add -g dodo-sync

Ausführen der CLI

Die CLI unterstützt zwei Modi: interaktiv für eine angeleitete Einrichtung und manuell für eine direkte Konfiguration. Interaktiver Modus: Führen Sie den Befehl ohne Argumente aus, um den Einrichtungsassistenten zu starten.

dodo-sync

Manueller Modus: Übergeben Sie die Argumente direkt, um den Assistenten zu überspringen.

dodo-sync -i [interval] -d [database] -u [database_uri] --scopes [scopes] --api-key [api_key] --env [environment]

Beispiele:

# MongoDB
dodo-sync -i 600 -d mongodb -u mongodb://mymongodb.url --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode

# PostgreSQL
dodo-sync -i 600 -d postgres -u postgresql://user:password@localhost:5432/mydb --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode

# MySQL
dodo-sync -i 600 -d mysql -u mysql://user:password@localhost:3306/mydb --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode

# ClickHouse
dodo-sync -i 600 -d clickhouse -u http://localhost:8123 --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode

CLI-Argumente

number

erforderlich

Synchronisierungsintervall in Sekunden. Die CLI wird in diesem Intervall kontinuierlich ausgeführt. Für eine einmalige Synchronisierung verwenden Sie .run() in Ihrem Code.

string

erforderlich

Datenbanktyp: "mongodb", "postgres", "mysql" oder "clickhouse".

string

erforderlich

Verbindungs-URI für Ihre Datenbank:

MongoDB: mongodb://localhost:27017 oder mongodb+srv://user:pass@cluster.mongodb.net/
PostgreSQL: postgresql://user:password@localhost:5432/mydb
MySQL: mysql://user:password@localhost:3306/mydb
ClickHouse: http://localhost:8123

string

erforderlich

Kommagetrennte Liste der zu synchronisierenden Entitäten: licences, payments, customers, subscriptions. Beispiel: "payments,customers".

string

erforderlich

Ihr Dodo Payments API-Schlüssel aus Developer → API Keys. Verwenden Sie einen Schlüssel aus demselben Modus wie --env.

string

erforderlich

Umgebung: "live_mode" oder "test_mode".

number

Ratenbegrenzung in Anfragen pro Sekunde. Steuert, wie schnell die Sync-Engine API-Anfragen stellt. Der Standardwert ist 10; Werte von 100 oder höher deaktivieren die Drosselung.

Verwendung in Ihrem Code

Integrieren Sie die Synchronisierungsfunktion direkt in Ihre Anwendung. Installieren Sie sie als Abhängigkeit:

npm install dodo-sync

bun add dodo-sync

Automatische Synchronisierung (intervallbasiert)

Führen Sie die Synchronisierung in regelmäßigen Abständen kontinuierlich aus:

import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  interval: 60, // Sync every 60 seconds
  database: 'mongodb',
  databaseURI: process.env.MONGODB_URI, // e.g., 'mongodb://localhost:27017'
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode' // or 'live_mode'
  }
});

// Initialize connection
await syncDodoPayments.init();

// Start the sync loop
syncDodoPayments.start();

Die Option interval ist erforderlich, wenn .start() verwendet wird. Die Synchronisierung läuft im angegebenen Intervall kontinuierlich, bis der Prozess beendet wird.

Manuelle Synchronisierung

Lösen Sie Synchronisierungsvorgänge bei Bedarf aus, beispielsweise über einen cron job, einen API-Endpunkt oder eine serverlose Funktion:

import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  database: 'mongodb',
  databaseURI: process.env.MONGODB_URI,
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode'
  }
});

try {
  // Initialize connection
  await syncDodoPayments.init();

  // Trigger a single sync operation
  await syncDodoPayments.run();
} finally {
  // Close the database connection
  await syncDodoPayments.disconnect();
}

Die Option interval ist für eine manuelle Synchronisierung nicht erforderlich. Rufen Sie .run() auf, wann immer Sie eine Synchronisierung benötigen. .run() wird erst aufgelöst, nachdem alle Schreibvorgänge in der Datenbank abgeschlossen sind. .close() ist ein Alias für .disconnect().

Ausführung auf Serverless

Auf Vercel, AWS Lambda oder ähnlichen Plattformen:

Rufen Sie .disconnect() in einem finally-Block auf, wie im obigen Beispiel, damit Verbindungen zwischen den Aufrufen nicht offen bleiben.
Verwenden Sie die Node.js-Laufzeitumgebung. Edge-Laufzeitumgebungen können keine Datenbankverbindungen öffnen.
Erhöhen Sie das Funktions-Timeout. Eine große Synchronisierung kann länger als das standardmäßige Limit dauern. Legen Sie auf Vercel export const maxDuration = 60; fest.
Synchronisieren Sie pro Aufruf weniger Bereiche, beispielsweise scopes: ['payments'], damit jeder Durchlauf kurz bleibt.

PostgreSQL-Beispiel

import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  interval: 60,
  database: 'postgres',
  databaseURI: process.env.POSTGRES_URI, // e.g., 'postgresql://user:password@localhost:5432/mydb'
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode'
  }
});

await syncDodoPayments.init();
syncDodoPayments.start();

MySQL-Beispiel

import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  interval: 60,
  database: 'mysql',
  databaseURI: process.env.MYSQL_URI, // e.g., 'mysql://user:password@localhost:3306/mydb'
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode'
  }
});

await syncDodoPayments.init();
syncDodoPayments.start();

ClickHouse-Beispiel

import { DodoSync } from 'dodo-sync';

const syncDodoPayments = new DodoSync({
  interval: 60,
  database: 'clickhouse',
  databaseURI: process.env.CLICKHOUSE_URI, // e.g., 'http://localhost:8123'
  scopes: ['licences', 'payments', 'customers', 'subscriptions'],
  dodoPaymentsOptions: {
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: 'test_mode'
  }
});

await syncDodoPayments.init();
syncDodoPayments.start();

Konstruktoroptionen

string

erforderlich

Datenbanktyp: "mongodb", "postgres", "mysql" oder "clickhouse".

string

erforderlich

Verbindungszeichenfolge für Ihre Datenbank:

MongoDB: mongodb://localhost:27017 oder mongodb+srv://...
PostgreSQL: postgresql://user:password@localhost:5432/mydb
MySQL: mysql://user:password@localhost:3306/mydb
ClickHouse: http://localhost:8123

string[]

erforderlich

Array der zu synchronisierenden Entitäten: "licences", "payments", "customers", "subscriptions". Jede Kombination ist möglich.

object

erforderlich

Konfiguration der Dodo Payments API. Eine vollständige Übersicht der Optionen finden Sie unter TypeScript SDK types.Erforderliche Eigenschaften:

bearerToken: Ihr Dodo Payments API-Schlüssel
environment: "test_mode" oder "live_mode"

number

Zeit in Sekunden zwischen automatischen Synchronisierungen. Erforderlich für .start(), optional für .run().

number

Ratenbegrenzung in Anfragen pro Sekunde. Der Standardwert ist 10; Werte von 100 oder höher deaktivieren die Drosselung.

Wichtige Informationen

MongoDB: Collections (subscriptions, payments, licences, customers) werden in der Datenbank erstellt, die in Ihrer Verbindungs-URI angegeben ist, beispielsweise mongodb://localhost:27017/my_database. Wenn die URI keine Datenbank angibt, verwendet Dodo Sync dodopayments_sync.PostgreSQL: Tabellen (Subscriptions, Payments, Licenses, Customers) werden in der Datenbank erstellt, die in Ihrer Verbindungs-URI angegeben ist. Daten werden als JSONB gespeichert.MySQL: Erfordert MySQL 8.0.20 oder höher. Tabellen (Subscriptions, Payments, Licenses, Customers) werden in der Datenbank erstellt, die in Ihrer Verbindungs-URI angegeben ist. Daten werden als JSON gespeichert.ClickHouse: Tabellen (Subscriptions, Payments, Licenses, Customers) werden mit der ReplacingMergeTree-Engine erstellt. Verwenden Sie beim Abfragen das Schlüsselwort FINAL, um deduplizierte Ergebnisse sicherzustellen.

Upgrade von 0.x

Version 1.0 ändert die Speicherung von MongoDB-Daten und erhöht die MySQL-Anforderung. Vor dem Upgrade:

MongoDB: Löschen Sie Ihre vorhandene licences-Collection. Lizenzdokumente werden jetzt nach der Lizenz- id statt nach subscription_id gespeichert, und die nächste Synchronisierung füllt die Collection erneut.
MongoDB: Prüfen Sie Ihre Verbindungs-URI. Daten werden jetzt in die Datenbank geschrieben, die in der URI angegeben ist, und nicht immer in dodopayments_sync. Um Ihre vorhandenen Daten weiterhin zu verwenden, fügen Sie dodopayments_sync in die URI ein oder lassen Sie die Datenbank weg.
MySQL: Führen Sie ein Upgrade auf MySQL 8.0.20 oder höher durch.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Was können Sie synchronisieren?

Payments

Customers

Subscriptions

Licenses

Datenbankunterstützung

Erste Schritte

Verwendung der CLI

Ausführen der CLI

CLI-Argumente

Verwendung in Ihrem Code

Automatische Synchronisierung (intervallbasiert)

Manuelle Synchronisierung

Ausführung auf Serverless

PostgreSQL-Beispiel

MySQL-Beispiel

ClickHouse-Beispiel

Konstruktoroptionen

Wichtige Informationen

Upgrade von 0.x

Weitere Ressourcen

GitHub Repository

npm Package

​Was können Sie synchronisieren?

Payments

Customers

Subscriptions

Licenses

​Datenbankunterstützung

​Erste Schritte

​Verwendung der CLI

​Ausführen der CLI

​CLI-Argumente

​Verwendung in Ihrem Code

​Automatische Synchronisierung (intervallbasiert)

​Manuelle Synchronisierung

​Ausführung auf Serverless

​PostgreSQL-Beispiel

​MySQL-Beispiel

​ClickHouse-Beispiel

​Konstruktoroptionen

​Wichtige Informationen

​Upgrade von 0.x

​Weitere Ressourcen

GitHub Repository

npm Package

Was können Sie synchronisieren?

Datenbankunterstützung

Erste Schritte

Verwendung der CLI

Ausführen der CLI

CLI-Argumente

Verwendung in Ihrem Code

Automatische Synchronisierung (intervallbasiert)

Manuelle Synchronisierung

Ausführung auf Serverless

PostgreSQL-Beispiel

MySQL-Beispiel

ClickHouse-Beispiel

Konstruktoroptionen

Wichtige Informationen

Upgrade von 0.x

Weitere Ressourcen