APIリファレンス - Dodo Payments Documentation

SDKs & Libraries

TypeScript、Python、Go、PHP、Java、Kotlin、C#、Ruby、Rust向けの公式バックエンドSDKです。これらのライブラリが認証、シリアライズ、エラー処理を担うため、インテグレーションに集中できます。

Mobile Checkout SDKs

Android、iOS、React Native、FlutterアプリからDodoのホスト型チェックアウトを開き、1回の呼び出しで型付きの結果を取得できます。これらのSDKにはAPI keyが含まれません。

Environment URL

Test Mode: https://test.dodopayments.com
Live Mode: https://live.dodopayments.com

認証

APIリクエストにはAPIキーが必要です。ただし、ライセンスを有効化、ライセンスを検証、ライセンスを無効化など、一部のパブリックエンドポイントは除きます。ダッシュボードでAPIキーを生成し、すべてのリクエストのAuthorizationヘッダーに含めてください。

Generate an API Key

ダッシュボードでDeveloper → API Keysに移動し、Add API Keyを選択します。呼び出すモードでAPI keyを作成してください。Test Modeのkeyはhttps://test.dodopayments.comでのみ使用でき、Live Modeのkeyはhttps://live.dodopayments.comでのみ使用できます。keyに分かりやすい名前を付け、アクセスレベルを選択します。

Enable write accessをオン（デフォルト）: すべてのAPI操作に対する完全な読み取り・書き込み権限です。
Enable write accessをオフ: 読み取り専用アクセスです。データ（決済、サブスクリプション、顧客、商品）の取得はできますが、リソースの作成や変更はできません。

分析ツールやダッシュボードインテグレーションなど、データの表示だけが必要なインテグレーションでは、Enable write accessをオフにしてください。

Store Your Key Securely

keyをすぐにコピーしてください。再度表示することはできません。DODO_PAYMENTS_API_KEYなどのenvironment variableに保存してください。

Authenticate Requests

すべてのリクエストのAuthorizationヘッダーにAPI keyを含めてください。

Authorization: Bearer YOUR_API_KEY

API keyをクライアントサイドコード、公開リポジトリ、またはバージョン管理に決して公開しないでください。

Response Format

成功したリクエストは、JSON bodyとともに200または201を返すか、bodyなしで204を返します。エラーの場合は、4xxまたは5xx statusと、codeおよびmessageを含むJSON bodyを返します。

{
  "payment_id": "pay_gr4RizvMOXFJ6xca3y2tU",
  "status": "succeeded",
  "total_amount": 2999,
  "currency": "USD",
  "created_at": "2024-01-15T10:30:00Z"
}

{
  "code": "INVALID_REQUEST_BODY",
  "message": "Your request body is invalid. Please check your request headers and object."
}

Rate Limits

APIでは、1秒あたりのバースト制限と1分あたりの継続制限という2つの制限が同時に適用されます。制限はビジネス全体に適用され、そのビジネスのすべてのAPI keysで共有されます。また、ビジネスのrate limit tierによって異なります。

デフォルトtier

Window	Limit
Per Second (Burst)	40 requests
Per Minute (Sustained)	240 requests

上位tier

APIの利用量が多いビジネスは、より高いrate limitにアップグレードできます。

Tier	Burst (per second)	Sustained (per minute)
Default	40	240
Tier 1	100	1,000
Tier 2	500	5,000

rate limit tierをアップグレードするには、support@dodopayments.comにメールしてください。

認証されていないリクエスト

有効なAPI keyを含まないリクエストは、IPアドレスによってrate limitedされます。

Window	Limit
Per Second (Burst)	20 requests
Per Minute (Sustained)	100 requests

Rate Limitヘッダー

レスポンスには、現在の使用状況を示すヘッダーが含まれます。

X-RateLimit-Limit — 現在のwindowで許可される最大リクエスト数です。
X-RateLimit-Remaining — 制限に達するまでに残っているリクエスト数です。
X-RateLimit-Reset — 現在のwindowがリセットされるまでの秒数です。

制限を超えると、APIは429 Too Many Requestsを返します。retry logicにはexponential backoffを実装してください。

エラー処理

エラーの意味と解決方法については、エラーコードとtransaction failuresのページを参照してください。

Error Codes

すべてのエラーコードとその意味を確認できます。

Transaction Failures

よくあるtransaction issuesとその対処方法を確認できます。

Webhooks

決済、サブスクリプション、その他のイベントが発生した際に、リアルタイム通知を受け取れます。ダッシュボードでwebhooksを設定し、インテグレーションに必要なイベントを処理してください。

Webhook Guide

webhooksを設定し、イベントを処理して、署名を検証します。

インテグレーションガイド

最初のインテグレーションを構築するには、次のガイドのいずれかから始めてください。

One-time Payments

checkout sessionsとpayment linksを作成し、決済を処理します。

Subscriptions

継続課金を設定し、プランを管理して、ライフサイクルイベントを処理します。

Usage-Based Billing

利用量を計測し、消費量に基づいて顧客に請求します。

Checkout Sessions

安全なホスト型チェックアウト体験を作成します。

SDKs & Libraries

Mobile Checkout SDKs

​Environment URL

​認証

​Response Format

​Rate Limits

​デフォルトtier

​上位tier

​認証されていないリクエスト

​Rate Limitヘッダー

​エラー処理

Error Codes

Transaction Failures

​Webhooks

Webhook Guide

​インテグレーションガイド

One-time Payments

Subscriptions

Usage-Based Billing

Checkout Sessions

Environment URL

認証

Response Format

Rate Limits

デフォルトtier

上位tier

認証されていないリクエスト

Rate Limitヘッダー

エラー処理

Webhooks

インテグレーションガイド