> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt
> Use this file to discover all available pages before exploring further.

# はじめに

> Dodo Payments APIは、支払い処理、サブスクリプション管理、デジタル製品の配信のための包括的なエンドポイントを提供します。当社のRESTful APIは業界標準に従い、すべての操作に対して詳細なレスポンスを提供します。

<Card title="SDKs & Libraries" icon="code" href="/developer-resources/dodo-payments-sdks">
  TypeScript、Python、Go、PHP、Java、Kotlin、C#、Ruby、React Native に対する公式 SDK を利用して統合を加速しましょう。これらのライブラリは API リクエスト、認証、エラー処理を簡素化し、優れた決済体験の構築に集中できるようにします。
</Card>

## 環境URL

* **テストモード**: [`https://test.dodopayments.com`](https://test.dodopayments.com)
* **本番モード**: [`https://live.dodopayments.com`](https://live.dodopayments.com)

<Note>
  「[テストモード vs 本番モード](/miscellaneous/test-mode-vs-live-mode)」について詳しく学んでください。
</Note>

## APIキー管理と認証

<Steps>
  <Step title="Access API Keys">
    ダッシュボードで **Developer → API Keys** に移動し、キーを管理します。
  </Step>

  <Step title="Generate a New Key">
    **Add API Key** を選択し、わかりやすい名前を入力して書き込みアクセスを設定します:

    * **書き込みアクセスを有効にする**（チェック済み）: すべてのAPI操作に対するフルリードおよび書き込み権限
    * **書き込みアクセスを有効にする**（未チェック）: 読み取り専用アクセス - データ（支払い、サブスクリプション、顧客、製品）を取得することのみ可能。リソースを作成または変更することはできません。

    <Tip>
      「Enable write access」のチェックを外して、ダッシュボード統合、分析ツール、およびデータの閲覧のみを行うシステムで書き込み操作を防ぎます。
    </Tip>
  </Step>

  <Step title="Store Your Key Securely">
    生成されたキーはすぐにコピーして安全に保管してください。
  </Step>

  <Step title="Authenticate Your API Requests">
    すべてのリクエストで API キーを使って認証を行います。以下の認証形式を適用してください:

    ```bash theme={null}
    Authorization: Bearer YOUR_API_KEY
    ```

    <Warning>
      シークレット API キーをクライアントサイドのコードや公開リポジトリで絶対に公開しないでください。
    </Warning>
  </Step>
</Steps>

## レスポンスフォーマット

<CodeGroup>
  ```json Success Response theme={null}
  {
    "id": "pay_1234567890",
    "status": "completed",
    "amount": 2999,
    "currency": "USD",
    "created_at": "2024-01-15T10:30:00Z"
  }
  ```

  ```json Error Response theme={null}
  {
    "code": "INVALID_REQUEST",
    "message": "The request contains invalid parameters"
  }
  ```
</CodeGroup>

## レート制限

当社の API はバースト保護付きの二重ウィンドウ方式のレート制限を採用しています。制限値は認証方法とビジネスティアに基づいて適用されます。

### デフォルトの制限（ティア 0）

| ウィンドウ        | 制限    |
| ------------ | ----- |
| 1 秒あたり（バースト） | 40 件  |
| 1 分あたり（継続）   | 240 件 |

### ビジネスティア

API の利用量が多い企業向けに、より高いレート制限を用意しています:

| ティア          | バースト（1 秒あたり） | 継続（1 分あたり） |
| ------------ | ------------ | ---------- |
| ティア 0（デフォルト） | 40           | 240        |
| ティア 1        | 100          | 1,000      |
| ティア 2        | 500          | 5,000      |

<Tip>
  ビジネスをより高いレート制限のティアにアップグレードするにはサポートに連絡してください。
</Tip>

### 未認証リクエスト

有効な認証ヘッダーがないリクエストは IP アドレス単位でレート制限されます:

| ウィンドウ        | 制限    |
| ------------ | ----- |
| 1 秒あたり（バースト） | 20 件  |
| 1 分あたり（継続）   | 100 件 |

### レート制限ヘッダー

これらのレスポンスヘッダーで使用状況を監視してください:

* `X-RateLimit-Limit` - 許可されている最大リクエスト数
* `X-RateLimit-Remaining` - 現在のウィンドウで残っているリクエスト数
* `X-RateLimit-Reset` - レート制限がリセットされるタイミング

<Note>
  レート制限を超えると API は `429 Too Many Requests` レスポンスを返します。リトライロジックには指数バックオフを実装してください。
</Note>

## エラー処理

エラーを効果的に管理するには、*Error Codes* セクションと *Transaction Failures* セクションで詳細なガイダンスをご確認ください。

<CardGroup cols={2}>
  <Card title="Error Codes" icon="triangle-exclamation" href="/api-reference/error-codes">
    包括的なエラーの詳細とその解決方法を掘り下げてください。
  </Card>

  <Card title="Transaction Failures" icon="circle-exclamation" href="/api-reference/transaction-failures">
    一般的なトランザクションの問題とその解決策に関する洞察を得ることができます。
  </Card>
</CardGroup>

## Webhooks

支払いイベントに関するリアルタイム通知を受け取ります。設定手順については [Webhook Guide](/developer-resources/webhooks) を参照してください。

<Card title="Webhook Guide" icon="webhook" href="/developer-resources/webhooks">
  リアルタイム通知とイベント処理のために Webhook を設定しましょう。
</Card>

## 関連開発者ガイド

APIを使用して主要な機能を実装する方法を理解するための包括的なガイドを探索してください。

<CardGroup cols={2}>
  <Card title="One-time Payments Integration" icon="code-merge" href="/developer-resources/integration-guide">
    アプリケーションに一回限りの支払い、チェックアウトセッション、支払いリンクを統合する方法を学びます
  </Card>

  <Card title="Subscription Integration" icon="credit-card" href="/developer-resources/subscription-integration-guide">
    サブスクリプションの実装、プランの管理、サブスクリプションライフサイクルイベントの処理に関する完全なガイド
  </Card>

  <Card title="Usage-Based Billing" icon="arrow-trend-up" href="/developer-resources/usage-based-billing-guide">
    メーター制課金と消費ベースの価格モデルのためのメーターと使用イベントの設定
  </Card>

  <Card title="Webhooks" icon="box" href="/developer-resources/webhooks">
    リアルタイム通知を受信し、Webhookイベントを使用してワークフローを自動化
  </Card>

  <Card title="Checkout Sessions" icon="cart-shopping" href="/developer-resources/checkout-session">
    完全にカスタマイズ可能で高度な機能を持つ安全なホスティング型チェックアウト体験を作成
  </Card>
</CardGroup>