Java

Das Java SDK bietet bequemen und ergonomischen Zugriff auf die Dodo Payments REST API für in Java geschriebene Anwendungen. Es nutzt Java-spezifische Funktionen wie Optional, Stream und CompletableFuture für die moderne Java-Entwicklung.

Installation

Maven

Fügen Sie die Abhängigkeit zu Ihrer pom.xml hinzu:

pom.xml

<dependency>
  <groupId>com.dodopayments.api</groupId>
  <artifactId>dodo-payments-java</artifactId>
  <version>1.97.1</version>
</dependency>

Gradle

Fügen Sie die Abhängigkeit zu Ihrer build.gradle hinzu:

build.gradle.kts

implementation("com.dodopayments.api:dodo-payments-java:1.97.1")

Verwenden Sie immer die neueste SDK-Version, um auf die neuesten Dodo Payments-Funktionen zuzugreifen. Prüfen Sie Maven Central auf die aktuelle Version.

Das SDK unterstützt Java 8 und alle späteren Versionen, einschließlich Java 11, 17 und 21.

Schnellstart

Initialisieren Sie den Client und erstellen Sie eine Checkout-Sitzung:

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;
import com.dodopayments.api.models.checkoutsessions.ProductItemReq;

// Configure using environment variables (DODO_PAYMENTS_API_KEY, DODO_PAYMENTS_BASE_URL)
// Or system properties (dodopayments.apiKey, dodopayments.baseUrl)
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

CheckoutSessionRequest params = CheckoutSessionRequest.builder()
    .addProductCart(ProductItemReq.builder()
        .productId("product_id")
        .quantity(1)
        .build())
    .build();
    
CheckoutSessionResponse checkoutSessionResponse = client.checkoutSessions().create(params);
System.out.println(checkoutSessionResponse.sessionId());

Speichern Sie Ihre API-Schlüssel stets sicher mittels Umgebungsvariablen, Systemeigenschaften oder eines sicheren Konfigurationsverwaltungssystems. Hardcodieren Sie sie niemals im Quellcode.

Kernfunktionen

Type Safety

Stark typisierte API mit Compile-Time-Sicherheit

Thread-Safe

Sicher für gleichzeitige Verwendung in Multi-Thread-Anwendungen

Builder Pattern

Intuitives Builder-Pattern zur Erstellung von Requests

Async Support

Unterstützung für CompletableFuture für asynchrone Operationen

Konfiguration

Umgebungsvariablen

Konfigurieren Sie mit Umgebungsvariablen oder Systemeigenschaften:

.env

DODO_PAYMENTS_API_KEY=your_api_key_here
DODO_PAYMENTS_BASE_URL=https://live.dodopayments.com

// Automatically reads from environment variables
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

Manuelle Konfiguration

Konfigurieren Sie manuell mit allen Optionen:

import java.time.Duration;

DodoPaymentsClient client = DodoPaymentsOkHttpClient.builder()
    .bearerToken("your_api_key_here")
    .baseUrl("https://live.dodopayments.com")
    .maxRetries(4)
    .timeout(Duration.ofSeconds(30))
    .responseValidation(true)
    .build();

Testmodus

Für die Test Mode-Umgebung konfigurieren:

DodoPaymentsClient testClient = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    .testMode()
    .build();

Häufige Operationen

Erstellen einer Checkout-Sitzung

Generieren Sie eine Checkout-Sitzung:

CheckoutSessionRequest params = CheckoutSessionRequest.builder()
    .addProductCart(ProductItemReq.builder()
        .productId("pdt_123")
        .quantity(1)
        .build())
    .returnUrl("https://yourdomain.com/return")
    .build();

CheckoutSessionResponse session = client.checkoutSessions().create(params);
System.out.println("Checkout URL: " + session.checkoutUrl());

Kunden verwalten

Erstellen und Abrufen von Kundeninformationen:

import com.dodopayments.api.models.customers.Customer;
import com.dodopayments.api.models.customers.CustomerCreateParams;

// Create a customer
CustomerCreateParams createParams = CustomerCreateParams.builder()
    .email("customer@example.com")
    .name("John Doe")
    .putMetadata("user_id", "12345")
    .build();

Customer customer = client.customers().create(createParams);

// Retrieve customer
Customer retrieved = client.customers().retrieve("cus_123");
System.out.println("Customer: " + retrieved.name() + " (" + retrieved.email() + ")");

Abonnements verwalten

Erstellen und verwalten Sie wiederkehrende Abonnements:

POST /subscriptions (die subscriptions.create-Methode des SDK) ist veraltet. Sie funktioniert weiterhin für bestehende Integrationen, für neue Integrationen sollten Abonnements jedoch über eine Checkout Session erstellt werden.

import com.dodopayments.api.models.payments.AttachExistingCustomer;
import com.dodopayments.api.models.payments.BillingAddress;
import com.dodopayments.api.models.misc.CountryCode;
import com.dodopayments.api.models.subscriptions.SubscriptionChargeParams;
import com.dodopayments.api.models.subscriptions.SubscriptionChargeResponse;
import com.dodopayments.api.models.subscriptions.SubscriptionCreateParams;
import com.dodopayments.api.models.subscriptions.SubscriptionCreateResponse;

// Create a subscription
SubscriptionCreateParams subscriptionParams = SubscriptionCreateParams.builder()
    .billing(BillingAddress.builder()
        .city("San Francisco")
        .country(CountryCode.US)
        .state("CA")
        .street("1 Market St")
        .zipcode("94105")
        .build())
    .customer(AttachExistingCustomer.builder()
        .customerId("cus_123")
        .build())
    .productId("pdt_456")
    .quantity(1)
    .paymentLink(true)
    .returnUrl("https://yourdomain.com/return")
    .build();

SubscriptionCreateResponse subscription = client.subscriptions().create(subscriptionParams);
System.out.println("Subscription ID: " + subscription.subscriptionId());

// Charge an on-demand subscription
// product_price is in the lowest currency denomination (e.g., 2500 = $25.00 USD)
SubscriptionChargeParams chargeParams = SubscriptionChargeParams.builder()
    .subscriptionId(subscription.subscriptionId())
    .productPrice(2500)
    .build();

SubscriptionChargeResponse chargeResponse = client.subscriptions().charge(chargeParams);
System.out.println("Payment ID: " + chargeResponse.paymentId());

productPrice wird in der kleinsten Währungseinheit angegeben (z. B. Cent für USD, Paise für INR). Um 25,00 $ zu berechnen, übergeben Sie 2500.

Die Abrechnung über subscriptions().charge(...) ist für On-Demand-Abonnements vorgesehen. Standardmäßige geplante Abonnements werden automatisch auf Grundlage des Preisplans des Produkts abgerechnet.

Nutzungsbasierte Abrechnung

Meter konfigurieren

Erstellen und verwalten Sie Meter zur Erfassung der Nutzung:

import com.dodopayments.api.models.meters.*;

// Create API calls meter
MeterCreateParams apiMeterParams = MeterCreateParams.builder()
    .name("API Requests")
    .eventName("api_request")
    .aggregation(MeterAggregation.builder()
        .type(MeterAggregation.Type.COUNT)
        .build())
    .measurementUnit("calls")
    .build();

Meter apiMeter = client.meters().create(apiMeterParams);
System.out.println("Meter created: " + apiMeter.id());

// List all meters
client.meters().list()
    .autoPager()
    .forEach(m -> System.out.println("Meter: " + m.name() + " - " + m.aggregation()));

Nutzungsereignisse erfassen

Benutzerdefinierte Ereignisse erfassen:

import com.dodopayments.api.models.usageevents.EventInput;
import com.dodopayments.api.models.usageevents.*;
import java.time.OffsetDateTime;

// Ingest single event
UsageEventIngestParams singleEventParams = UsageEventIngestParams.builder()
    .addEvent(EventInput.builder()
        .eventId("api_call_" + System.currentTimeMillis())
        .customerId("cus_abc123")
        .eventName("api_request")
        .timestamp(OffsetDateTime.now())
        .putMetadata("endpoint", "/api/v1/users")
        .putMetadata("method", "GET")
        .putMetadata("tokens_used", "150")
        .build())
    .build();

UsageEventIngestResponse response = client.usageEvents().ingest(singleEventParams);
System.out.println("Processed: " + response.ingestedCount());

Ereignisse stapelweise erfassen

Mehrere Ereignisse effizient erfassen (max. 1000 pro Anfrage):

UsageEventIngestParams.Builder batchBuilder = UsageEventIngestParams.builder();

for (int i = 0; i < 100; i++) {
    batchBuilder.addEvent(EventInput.builder()
        .eventId("batch_event_" + i + "_" + System.currentTimeMillis())
        .customerId("cus_abc123")
        .eventName("video_transcode")
        .timestamp(OffsetDateTime.now().minusSeconds(i))
        .putMetadata("video_id", "video_" + i)
        .putMetadata("duration_seconds", String.valueOf(120 + i))
        .build());
}

UsageEventIngestResponse batchResponse = client.usageEvents().ingest(batchBuilder.build());
System.out.println("Batch processed: " + batchResponse.ingestedCount() + " events");

Fehlerbehandlung

Umfassende Fehlerbehandlung für verschiedene Szenarien:

import com.dodopayments.api.errors.*;

try {
    Payment payment = client.payments().retrieve("pay_invalid");
} catch (NotFoundException e) {
    System.err.println("Payment not found: " + e.getMessage());
} catch (UnauthorizedException e) {
    System.err.println("Authentication failed: " + e.getMessage());
} catch (PermissionDeniedException e) {
    System.err.println("Permission denied: " + e.getMessage());
} catch (BadRequestException e) {
    System.err.println("Invalid request: " + e.getMessage());
} catch (UnprocessableEntityException e) {
    System.err.println("Validation error: " + e.getMessage());
} catch (RateLimitException e) {
    System.err.println("Rate limit exceeded: " + e.getMessage());
    // SDK automatically retries with backoff
} catch (InternalServerException e) {
    System.err.println("Server error: " + e.getMessage());
} catch (DodoPaymentsServiceException e) {
    System.err.println("API error: " + e.statusCode() + " - " + e.getMessage());
}

Das SDK wiederholt Anfragen bei Verbindungsfehlern, 408-, 409-, 429- und 5xx-Fehlern automatisch mit exponentiellem Backoff.

Asynchrone Vorgänge

Verwenden Sie CompletableFuture für asynchrone Vorgänge:

import java.util.concurrent.CompletableFuture;

CompletableFuture<CheckoutSessionResponse> future = client.async()
    .checkoutSessions()
    .create(params);

// Handle response asynchronously
future.thenAccept(response -> {
    System.out.println("Session created: " + response.sessionId());
}).exceptionally(ex -> {
    System.err.println("Error: " + ex.getMessage());
    return null;
});

Spring Boot-Integration

Konfigurationsklasse

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class DodoPaymentsConfig {
    
    @Value("${dodo.api.key}")
    private String apiKey;
    
    @Value("${dodo.environment:test}")
    private String environment;
    
    @Bean
    public DodoPaymentsClient dodoPayments() {
        return DodoPaymentsOkHttpClient.builder()
            .bearerToken(apiKey)
            .baseUrl(environment.equals("live") 
                ? "https://live.dodopayments.com" 
                : "https://test.dodopayments.com")
            .build();
    }
}

Service-Schicht

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.models.checkoutsessions.*;
import org.springframework.stereotype.Service;

@Service
public class PaymentService {
    
    private final DodoPaymentsClient client;
    
    public PaymentService(DodoPaymentsClient client) {
        this.client = client;
    }
    
    public CheckoutSessionResponse createCheckout(List<ProductItemReq> items) {
        CheckoutSessionRequest params = CheckoutSessionRequest.builder()
            .productCart(items)
            .returnUrl("https://yourdomain.com/return")
            .build();
            
        return client.checkoutSessions().create(params);
    }
}

Ressourcen

GitHub Repository

Quellcode anzeigen und beitragen

API Reference

Vollständige API-Dokumentation

Discord Community

Hilfe erhalten und sich mit Entwicklern austauschen

Report Issues

Fehler melden oder Funktionen anfordern

Support

Benötigen Sie Hilfe mit dem Java SDK?

Discord: Treten Sie unserem Community-Server für Support in Echtzeit bei
E-Mail: Kontaktieren Sie uns unter support@dodopayments.com
GitHub: Eröffnen Sie ein Issue im Repository

Mitwirken

Wir freuen uns über Beiträge! Lesen Sie die Richtlinien zum Mitwirken, um loszulegen.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Installation

Maven

Gradle

Schnellstart

Kernfunktionen

Type Safety

Thread-Safe

Builder Pattern

Async Support

Konfiguration

Umgebungsvariablen

Manuelle Konfiguration

Testmodus

Häufige Operationen

Erstellen einer Checkout-Sitzung

Kunden verwalten

Abonnements verwalten

Nutzungsbasierte Abrechnung

Meter konfigurieren

Nutzungsereignisse erfassen

Ereignisse stapelweise erfassen

Fehlerbehandlung

Asynchrone Vorgänge

Spring Boot-Integration

Konfigurationsklasse

Service-Schicht

Ressourcen

GitHub Repository

API Reference

Discord Community

Report Issues

Support

Mitwirken

​Installation

​Maven

​Gradle

​Schnellstart

​Kernfunktionen

Type Safety

Thread-Safe

Builder Pattern

Async Support

​Konfiguration

​Umgebungsvariablen

​Manuelle Konfiguration

​Testmodus

​Häufige Operationen

​Erstellen einer Checkout-Sitzung

​Kunden verwalten

​Abonnements verwalten

​Nutzungsbasierte Abrechnung

​Meter konfigurieren

​Nutzungsereignisse erfassen

​Ereignisse stapelweise erfassen

​Fehlerbehandlung

​Asynchrone Vorgänge

​Spring Boot-Integration

​Konfigurationsklasse

​Service-Schicht

​Ressourcen

GitHub Repository

API Reference

Discord Community

Report Issues

​Support

​Mitwirken

Installation

Maven

Gradle

Schnellstart

Kernfunktionen

Konfiguration

Umgebungsvariablen

Manuelle Konfiguration

Testmodus

Häufige Operationen

Erstellen einer Checkout-Sitzung

Kunden verwalten

Abonnements verwalten

Nutzungsbasierte Abrechnung

Meter konfigurieren

Nutzungsereignisse erfassen

Ereignisse stapelweise erfassen

Fehlerbehandlung

Asynchrone Vorgänge

Spring Boot-Integration

Konfigurationsklasse

Service-Schicht

Ressourcen

Support

Mitwirken