Synkronisera med din databas

Synkronisera dina Dodo Payments-data till din egen databas för analys, rapportering och integrationer. Synkroniseringsmotorn replikerar automatiskt betalningar, kunder, prenumerationer och licenser till MongoDB, PostgreSQL, MySQL eller ClickHouse.

Paket: dodo-sync på npm | Källa: GitHub

Vad kan du synkronisera?

Välj valfri kombination av dessa entiteter:

Payments

Alla betalningstransaktioner, inklusive engångsbetalningar, återbetalningar och statusuppdateringar.

Customers

Kundprofiler, kontaktinformation och metadata.

Subscriptions

Prenumerationsdata, faktureringscykler och statusändringar.

Licenses

Licensnycklar, aktiveringar och statusuppdateringar.

Ange vilka entiteter som ska synkroniseras med parametern scopes. Varje körning hämtar alla poster inom de valda omfången och skriver dem med ID, så att befintliga rader uppdateras på plats i stället för att dupliceras. I MongoDB lagras licensnycklar efter prenumerations-ID, så en prenumeration med flera licensnycklar behåller endast en av dem.

Databasstöd

Dodo Sync stöder MongoDB, PostgreSQL, MySQL och ClickHouse. Stöd för Snowflake och andra databaser, ETL-pipelines och realtidssynkronisering utvecklas. Om du vill bidra med en ny databasintegration skickar du en pull request till GitHub-förrådet.

Kom igång

Använd Dodo Sync via CLI för snabb konfigurering eller programmatiskt i din kod för integrering i din applikation. Båda metoderna erbjuder samma funktionalitet.

Använda CLI

Installera CLI globalt för att kunna köra det var som helst:

npm install -g dodo-sync

bun add -g dodo-sync

Köra CLI

CLI stöder två lägen: interaktivt för guidad konfigurering och manuellt för direkt konfigurering. Interaktivt läge: Kör utan argument för att starta konfigurationsguiden.

dodo-sync

Manuellt läge: Skicka argument direkt för att hoppa över guiden.

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

Exempel:

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

number

obligatorisk

Synkroniseringsintervall i sekunder. CLI körs kontinuerligt med detta intervall. För en engångssynkronisering använder du .run() i din kod.

string

obligatorisk

Databastyp: "mongodb", "postgres", "mysql" eller "clickhouse".

string

obligatorisk

Anslutnings-URI för din databas:

MongoDB: mongodb://localhost:27017 eller 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

obligatorisk

Kommaseparerad lista över entiteter som ska synkroniseras: licences, payments, customers, subscriptions. Exempel: "payments,customers".

string

obligatorisk

Din Dodo Payments API-nyckel från Developer → API Keys. Använd en nyckel från samma läge som --env.

string

obligatorisk

Miljö: "live_mode" eller "test_mode".

number

Hastighetsbegränsning i förfrågningar per sekund. Styr hur snabbt synkroniseringsmotorn gör API-förfrågningar. Standardvärdet är 10; värden på 100 eller högre inaktiverar begränsningen.

Använda i din kod

Integrera synkroniseringsfunktionen direkt i din applikation. Installera den som ett beroende:

npm install dodo-sync

bun add dodo-sync

Automatisk synkronisering (intervallbaserad)

Kör synkroniseringen kontinuerligt med regelbundna intervall:

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();

Alternativet interval krävs när .start() används. Synkroniseringen körs kontinuerligt med det angivna intervallet tills processen stoppas.

Manuell synkronisering

Utlös synkroniseringsåtgärder på begäran, till exempel från ett cron-jobb eller en API-endpoint:

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'
  }
});

// Initialize connection
await syncDodoPayments.init();

// Trigger a single sync operation
await syncDodoPayments.run();

Alternativet interval krävs inte för manuell synkronisering. Anropa .run() när du behöver synkronisera.

PostgreSQL-exempel

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-exempel

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-exempel

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();

Konstruktörsalternativ

string

obligatorisk

Databastyp: "mongodb", "postgres", "mysql" eller "clickhouse".

string

obligatorisk

Anslutningssträng för din databas:

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

string[]

obligatorisk

Array med entiteter som ska synkroniseras: "licences", "payments", "customers", "subscriptions". Inkludera valfri kombination.

object

obligatorisk

Dodo Payments API-konfiguration. Se TypeScript SDK-typerna för fullständiga alternativ.Obligatoriska egenskaper:

bearerToken: Din Dodo Payments API-nyckel
environment: "test_mode" eller "live_mode"

number

Tid i sekunder mellan automatiska synkroniseringar. Krävs för .start(), valfritt för .run().

number

Hastighetsbegränsning i förfrågningar per sekund. Standardvärdet är 10; värden på 100 eller högre inaktiverar begränsningen.

Viktig information

MongoDB: En databas med namnet dodopayments_sync skapas automatiskt på din server. Databasnamnet är fast och kan inte ändras.PostgreSQL: Tabeller (Subscriptions, Payments, Licenses, Customers) skapas i den databas som anges i din anslutnings-URI. Data lagras som JSONB.MySQL: Tabeller (Subscriptions, Payments, Licenses, Customers) skapas i den databas som anges i din anslutnings-URI. Data lagras som JSON.ClickHouse: Tabeller (Subscriptions, Payments, Licenses, Customers) skapas med ReplacingMergeTree-motorn. När du kör frågor använder du nyckelordet FINAL för att säkerställa deduplicerade resultat.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Vad kan du synkronisera?

Payments

Customers

Subscriptions

Licenses

Databasstöd

Kom igång

Använda CLI

Köra CLI

CLI-argument

Använda i din kod

Automatisk synkronisering (intervallbaserad)

Manuell synkronisering

PostgreSQL-exempel

MySQL-exempel

ClickHouse-exempel

Konstruktörsalternativ

Viktig information

Ytterligare resurser

GitHub Repository

npm Package

​Vad kan du synkronisera?

Payments

Customers

Subscriptions

Licenses

​Databasstöd

​Kom igång

​Använda CLI

​Köra CLI

​CLI-argument

​Använda i din kod

​Automatisk synkronisering (intervallbaserad)

​Manuell synkronisering

​PostgreSQL-exempel

​MySQL-exempel

​ClickHouse-exempel

​Konstruktörsalternativ

​Viktig information

​Ytterligare resurser

GitHub Repository

npm Package

Vad kan du synkronisera?

Databasstöd

Kom igång

Använda CLI

Köra CLI

CLI-argument

Använda i din kod

Automatisk synkronisering (intervallbaserad)

Manuell synkronisering

PostgreSQL-exempel

MySQL-exempel

ClickHouse-exempel

Konstruktörsalternativ

Viktig information

Ytterligare resurser