Java - Dodo Payments Documentation

Java SDKは、Javaで書かれたアプリケーション向けにDodo Payments REST APIへの便利でエルゴノミックなアクセスを提供します。Optional、Stream、CompletableFutureなどのJava特有の機能を利用して、モダンなJava開発を実現します。

インストール

Maven

依存関係をあなたのpom.xmlに追加します:

pom.xml

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

Gradle

依存関係をあなたのbuild.gradleに追加します:

build.gradle.kts

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

常に最新の SDK バージョンを使用して最新の Dodo Payments 機能にアクセスしてください。最新バージョンはMaven Centralで確認できます。

SDK は Java 8 およびそれ以降のすべてのバージョン（Java 11、17、21 を含む）をサポートしています。

クイックスタート

クライアントを初期化し、チェックアウトセッションを作成します:

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

API キーは常に環境変数、システムプロパティ、または安全な構成管理システムを使用して安全に保存してください。ソースコードにハードコードしないでください。

コア機能

Type Safety

コンパイル時の安全性を備えた強く型付けされた API

Thread-Safe

マルチスレッドアプリケーションでの同時使用にも安全

Builder Pattern

リクエスト構築のための直感的なビルダーパターン

Async Support

非同期操作のための CompletableFuture サポート

設定

環境変数

環境変数またはシステムプロパティを使用して設定します:

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

手動設定

すべてのオプションを手動で設定します:

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

テストモード

テスト/サンドボックス環境用に設定します:

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

一般的な操作

チェックアウトセッションの作成

チェックアウトセッションを生成します:

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

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

顧客の管理

顧客情報を作成および取得します:

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

サブスクリプションの管理

定期的なサブスクリプションを作成および管理します:

import com.dodopayments.api.models.payments.AttachExistingCustomer;
import com.dodopayments.api.models.payments.BillingAddress;
import com.dodopayments.api.models.payments.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 は、最小貨幣単位（例: USDのセント、INRのパイサ）で表されます。$25.00を請求するには、2500 を渡します。

subscriptions().charge(...) による請求は、オンデマンドサブスクリプションを対象としています。標準のスケジュール済みサブスクリプションは、製品の価格スケジュールに基づいて自動で請求されます。

使用量ベースの請求

メーターの設定

使用量を追跡するためのメーターを作成および管理します。

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

// Create API calls meter
MeterCreateParams apiMeterParams = MeterCreateParams.builder()
    .name("API Requests")
    .eventName("api_request")
    .aggregation("count")
    .putMetadata("category", "api_usage")
    .build();

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

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

使用イベントの取り込み

カスタムイベントを追跡します。

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

// Ingest single event
UsageEventIngestParams singleEventParams = UsageEventIngestParams.builder()
    .addEvent(UsageEventIngestParams.Event.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());

バッチイベントの取り込み

複数のイベントを効率的に取り込みます（リクエストあたり最大1000件）。

UsageEventIngestParams.Builder batchBuilder = UsageEventIngestParams.builder();

for (int i = 0; i < 100; i++) {
    batchBuilder.addEvent(UsageEventIngestParams.Event.builder()
        .eventId("batch_event_" + i + "_" + System.currentTimeMillis())
        .customerId("cus_abc123")
        .eventName("video_transcode")
        .timestamp(OffsetDateTime.now().minusMinutes(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");

エラーハンドリング

さまざまなシナリオに対する包括的なエラーハンドリング。

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

SDKは、接続エラー、408、409、429、および5xxエラーで指数バックオフでリクエストを自動的に再試行します。

非同期操作

非同期操作にはCompletableFutureを使用します。

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 統合

設定クラス

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

サービス層

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

リソース

GitHub Repository

ソースコードを表示し、貢献してください

API Reference

完全なAPIドキュメント

Discord Community

助けを求め、開発者とつながる

Report Issues

バグを報告するか、機能をリクエストする

サポート

Java SDKに関する助けが必要ですか？

Discord: リアルタイムサポートのために私たちのコミュニティサーバーに参加してください
Email: support@dodopayments.com にご連絡ください
GitHub: リポジトリで問題を開いてください

コントリビューション

貢献を歓迎します！コントリビューションガイドラインを確認して始めましょう。

​インストール

​Maven

​Gradle

​クイックスタート

​コア機能

Type Safety

Thread-Safe

Builder Pattern

Async Support

​設定

​環境変数

​手動設定

​テストモード

​一般的な操作

​チェックアウトセッションの作成

​顧客の管理

​サブスクリプションの管理

​使用量ベースの請求

​メーターの設定

​使用イベントの取り込み

​バッチイベントの取り込み

​エラーハンドリング

​非同期操作

​Spring Boot 統合

​設定クラス

​サービス層

​リソース

GitHub Repository

API Reference

Discord Community

Report Issues

​サポート

​コントリビューション

インストール

Maven

Gradle

クイックスタート

コア機能

設定

環境変数

手動設定

テストモード

一般的な操作

チェックアウトセッションの作成

顧客の管理

サブスクリプションの管理

使用量ベースの請求

メーターの設定

使用イベントの取り込み

バッチイベントの取り込み

エラーハンドリング

非同期操作

Spring Boot 統合

設定クラス

サービス層

リソース

サポート

コントリビューション