公式 SDK - Dodo Payments Documentation

公式の Dodo Payments server SDK は 9 言語で利用できます。別途提供されている checkout SDK を使用すると、Android、iOS、React Native、Flutter アプリから hosted checkout を開けます。

TypeScript

promise ベースの API と auto-pagination を備えた、Node.js 向けの type-safe SDK。

Python

async/await をサポートする、Python 3.9 以降向けの Pythonic な interface。

Go

context サポートと strong typing を備えた、idiomatic な Go interface。

PHP

PHP 8.1 以降向けの PSR-4 準拠 SDK。

Java

Maven と Gradle をサポートする、Java 8 以降向けの thread-safe SDK。

Kotlin

coroutine と null safety に対応した Kotlin SDK。

C#

async TaskベースのAPIを備えた、.NET Standard 2.0以降向けの型安全なSDKです。

Ruby

Ruby の規約に従う Ruby SDK。

Rust

Rust 1.75 以降向けに Tokio と reqwest 上に構築された、async-first SDK。

クイックスタート

Install the SDK

パッケージマネージャーを使用して、お使いの言語向けのSDKをインストールします。

npm install dodopayments

pip install dodopayments

go get github.com/dodopayments/dodopayments-go

composer require dodopayments/client

// build.gradle.kts
implementation("com.dodopayments.api:dodo-payments-java:1.117.0")

// build.gradle.kts
implementation("com.dodopayments.api:dodo-payments-kotlin:1.117.0")

dotnet add package DodoPayments.Client

bundle add dodopayments

cargo add dodopayments

Mavenの座標とバージョン固有のオプションについては、各SDKのページを参照してください。

Initialize the Client

DODO_PAYMENTS_API_KEY環境変数からAPI keyを読み取ります。例ではtest modeに接続します。Test Mode vs Live Modeを参照してください。

TypeScript
Python
Go
PHP
Rust

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode',
});

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ["DODO_PAYMENTS_API_KEY"],
    environment="test_mode",
)

import (
    "os"

    "github.com/dodopayments/dodopayments-go"
    "github.com/dodopayments/dodopayments-go/option"
)

client := dodopayments.NewClient(
    option.WithBearerToken(os.Getenv("DODO_PAYMENTS_API_KEY")),
    option.WithEnvironmentTestMode(),
)

use Dodopayments\Client;

$client = new Client(
    bearerToken: getenv('DODO_PAYMENTS_API_KEY'),
    baseUrl: 'https://test.dodopayments.com',
);

use dodopayments::{Client, ClientConfig, Environment};

let config = ClientConfig::from_env()
    .expect("DODO_PAYMENTS_API_KEY must be set")
    .with_environment(Environment::TestMode);
let client = Client::new(config).expect("failed to create client");

Java、Kotlin、C#、Rubyについては、各SDKのページにあるclient setupを参照してください。

API keyは環境変数またはsecrets managerで管理してください。version controlにコミットしないでください。

Create a Checkout Session

checkout sessionを作成し、返されたcheckout_urlにcustomerをリダイレクトします。

const session = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'YOUR_PRODUCT_ID', quantity: 1 }],
});

console.log(session.checkout_url);

他の言語で同じ呼び出しを行う方法、およびpayment linksとwebhooksについては、Integration Guideを参照してください。

主な機能

すべてのbackend SDKには次の機能が含まれます。

型安全性: コンパイル時の安全性とIDEサポートの向上を実現する強い型付け。
Error Handling: APIが返したHTTP statusとerror bodyを公開する型付きエラー。
Authentication: 環境変数から読み取るAPI key authentication。
Async Support: 該当する場合に使用できる最新のasync/awaitパターン。
Auto-Pagination: list responseの自動ページネーション。
Usage Events: usage-based billing向けにusage eventsを送信するメソッド。
Test Mode: clientをtest modeに接続する設定。実際のお金は移動しません。

Mobile Checkout SDKs

ネイティブAndroid、iOS、React Native、Flutterアプリでは、mobile checkout SDKsを使用してください。これらはplatformの実際のbrowser surface（WebViewではありません）でDodoのhosted checkout pageを開くため、Apple PayとGoogle Payはopen webと同じように動作します。 4つすべてのmobile SDKsは同じcontractを共有します。start(...)はtyped CheckoutResultを返し、いずれもAPI keyを保持せず、APIを直接呼び出すこともありません。

Android

Chrome Custom Tabを開くKotlin SDK。minSdk 23以降が必要です。

iOS

SFSafariViewControllerを開くSwift SDK。iOS 16以降が必要です。

React Native

両方のnative core上で動作するTurbo Module。React Native 0.76以降が必要です。

Flutter

両方のnative core上で動作するPigeon channel。Flutter 3.44以降が必要です。

Mobile Integration Guide

backendのcheckout sessionからcallback scheme setupまでを含む、エンドツーエンドのmobile payment flow。

Command-Line Interface

Dodo CLIは、terminalからpayments、customers、webhooksを管理します。interactive TUI、AI assistant、webhook testing toolsが含まれています。

CLI

AI assistantとwebhook testingを備えたinteractive terminal client。

次のコマンドでmacOSまたはLinuxにインストールします。

curl -fsSL https://dodopayments.com/install.sh | sh

Framework Adaptors

Adaptorsは、frameworkにcheckout、customer portal、webhook handlersを追加します。

推奨Framework

Next.js

App Routerでcheckout、customer portal、webhooksを処理するroute handlers。

Better Auth

userのsignup時にcustomerを作成し、auth flowにcheckoutとcustomer portalを追加します。

Supabase

auth、database schema、webhooks、pricing pageを備えたNext.jsとSupabaseのstarter。

Convex

Convex backend向けのcheckout、customer portal、webhook functions。

All Other Framework Adaptors

SvelteKit

Nuxt

Remix

Express

Fastify

Hono

Astro

TanStack

Bun

Node.js SDKからの移行

TypeScript SDKはlegacy Node.js SDKに置き換わるものです。Node.js SDKを使用している場合は、migration guideを参照してintegrationを更新してください。

ヘルプを得る

Discord: リアルタイムのサポートについては、community serverに参加してください。
Email: support@dodopayments.comまでお問い合わせください。
GitHub: 該当するSDK repositoryでissueを作成してください。
Documentation: API referenceをご覧ください。

コントリビューション

各SDK repositoryではcontributionを受け付けています。ほとんどのrepositoryには、バグの報告、feature request、pull requestの送信、テストの実行、code style conventionsに関するガイドラインを記載したCONTRIBUTING.mdファイルがあります。各SDKのページから、GitHub repositoryとcontribution guidelinesにアクセスできます。

TypeScript

Python

Go

PHP

Java

Kotlin

C#

Ruby

Rust

​クイックスタート

​主な機能

​Mobile Checkout SDKs

Android

iOS

React Native

Flutter

Mobile Integration Guide

​Command-Line Interface

CLI

​Framework Adaptors

​推奨Framework

Next.js

Better Auth

Supabase

Convex

SvelteKit

Nuxt

Remix

Express

Fastify

Hono

Astro

TanStack

Bun

​Node.js SDKからの移行

​ヘルプを得る

​コントリビューション

クイックスタート

主な機能

Mobile Checkout SDKs

Command-Line Interface

Framework Adaptors

推奨Framework

Node.js SDKからの移行

ヘルプを得る

コントリビューション