Python SDKは、Dodo Payments APIへのPythonicインターフェースを提供し、リクエストとレスポンスの型定義を持つ同期および非同期クライアントを提供します。Python 3.7以上をサポートし、包括的なテストカバレッジが含まれています。
インストール pipを使用してSDKをインストールします:
aiohttpを使用して非同期パフォーマンスを向上させるためには:
pip install dodopayments[aiohttp] SDKはPython 3.7以上が必要です。最良の体験とセキュリティ更新のために、最新の安定版Pythonの使用をお勧めします。
クイックスタート 同期クライアント import os from dodopayments import DodoPayments client = DodoPayments( bearer_token = os.environ.get( "DODO_PAYMENTS_API_KEY" ), # This is the default and can be omitted environment = "test_mode" , # defaults to "live_mode" ) checkout_session_response = client.checkout_sessions.create( product_cart = [ { "product_id" : "product_id" , "quantity" : 1 } ], ) print (checkout_session_response.session_id) 非同期クライアント import os import asyncio from dodopayments import AsyncDodoPayments client = AsyncDodoPayments( bearer_token = os.environ.get( "DODO_PAYMENTS_API_KEY" ), environment = "test_mode" , ) async def main () -> None : checkout_session_response = await client.checkout_sessions.create( product_cart = [ { "product_id" : "product_id" , "quantity" : 1 , } ], ) print (checkout_session_response.session_id) asyncio.run(main()) APIキーは常に環境変数を使用して安全に保管してください。バージョン管理にコミットしないでください。
コア機能
Pythonicインターフェース PEP 8ガイドラインとPythonの慣習に従ったクリーンでイディオマティックなPythonコード
Async/Await asyncioとオプションのaiohttp統合による非同期操作の完全サポート
型ヒント IDEサポートとmypyによる型チェックのための完全な型ヒント
自動ページネーション 簡単な反復処理によるリストレスポンスの自動ページネーション
環境変数 環境変数を使用して設定します:
DODO_PAYMENTS_API_KEY = your_api_key_here タイムアウト リクエストのタイムアウトをグローバルまたはリクエストごとに設定します:
import httpx from dodopayments import DodoPayments # Configure default for all requests (default is 1 minute) client = DodoPayments( timeout = 20.0 , # 20 seconds ) # More granular control client = DodoPayments( timeout = httpx.Timeout( 60.0 , read = 5.0 , write = 10.0 , connect = 2.0 ), ) # Override per-request client.with_options( timeout = 5.0 ).checkout_sessions.create( product_cart = [ { "product_id" : "product_id" , "quantity" : 0 , } ], ) リトライ 自動リトライの動作を設定します:
from dodopayments import DodoPayments # Configure default for all requests (default is 2) client = DodoPayments( max_retries = 0 , # disable retries ) # Override per-request client.with_options( max_retries = 5 ).checkout_sessions.create( product_cart = [ { "product_id" : "product_id" , "quantity" : 0 , } ], ) 一般的な操作 チェックアウトセッションの作成 チェックアウトセッションを生成します:
session = client.checkout_sessions.create( product_cart = [ { "product_id" : "prod_123" , "quantity" : 1 } ], return_url = "https://yourdomain.com/return" ) print ( f "Checkout URL: { session.url } " ) 顧客の管理 顧客情報を作成および取得します:
# Create a customer customer = client.customers.create( email = "[email protected] " , name = "John Doe" , metadata = { "user_id" : "12345" } ) # Retrieve customer customer = client.customers.retrieve( "cus_123" ) print ( f "Customer: { customer.name } ( { customer.email } )" ) サブスクリプションの管理 定期的なサブスクリプションを作成および管理します:
# Create a subscription subscription = client.subscriptions.create( customer_id = "cus_123" , product_id = "prod_456" , price_id = "price_789" ) # Retrieve usage history usage_history = client.subscriptions.retrieve_usage_history( subscription.id, start_date = "2024-01-01T00:00:00Z" ) 使用量ベースの請求 使用量イベントの取り込み 使用量ベースの請求のためのカスタムイベントを追跡します:
response = client.usage_events.ingest( events = [ { "event_id" : "api_call_12345" , "customer_id" : "cus_abc123" , "event_name" : "api_request" , "timestamp" : "2024-01-15T10:30:00Z" , "metadata" : { "endpoint" : "/api/v1/users" , "method" : "GET" , "tokens_used" : "150" } } ] ) イベントのリストと取得 # Get a specific event event = client.usage_events.retrieve( "api_call_12345" ) # List events with filtering events = client.usage_events.list( customer_id = "cus_abc123" , event_name = "api_request" , limit = 20 ) for event in events.data: print ( f "Event: { event.event_id } at { event.timestamp } " ) ページネーション 自動ページネーション すべてのアイテムを自動的に反復処理します:
from dodopayments import DodoPayments client = DodoPayments() all_payments = [] # Automatically fetches more pages as needed for payment in client.payments.list(): all_payments.append(payment) print (all_payments) 非同期ページネーション import asyncio from dodopayments import AsyncDodoPayments client = AsyncDodoPayments() async def main () -> None : all_payments = [] # Iterate through items across all pages async for payment in client.payments.list(): all_payments.append(payment) print (all_payments) asyncio.run(main()) 手動ページネーション ページネーションをより制御するために:
# Access items from current page first_page = client.payments.list() for payment in first_page.items: print (payment.brand_id) # Check for more pages if first_page.has_next_page(): next_page = first_page.get_next_page() print ( f "Fetched { len (next_page.items) } more items" ) HTTPクライアント設定 基盤となるhttpxクライアントをカスタマイズします:
import httpx from dodopayments import DodoPayments, DefaultHttpxClient client = DodoPayments( base_url = "http://my.test.server.example.com:8083" , http_client = DefaultHttpxClient( proxy = "http://my.test.proxy.example.com" , transport = httpx.HTTPTransport( local_address = "0.0.0.0" ), ), ) aiohttpを使用した非同期 aiohttpを使用して非同期パフォーマンスを向上させます:
import asyncio from dodopayments import DefaultAioHttpClient from dodopayments import AsyncDodoPayments async def main () -> None : async with AsyncDodoPayments( bearer_token = "My Bearer Token" , http_client = DefaultAioHttpClient(), ) as client: checkout_session_response = await client.checkout_sessions.create( product_cart = [ { "product_id" : "product_id" , "quantity" : 0 , } ], ) print (checkout_session_response.session_id) asyncio.run(main()) ロギング 環境変数を設定してロギングを有効にします:
export DODO_PAYMENTS_LOG = info またはデバッグレベルのロギングのために:
export DODO_PAYMENTS_LOG = debug フレームワーク統合 FastAPI from fastapi import FastAPI, HTTPException from dodopayments import AsyncDodoPayments from pydantic import BaseModel import os app = FastAPI() dodo = AsyncDodoPayments( bearer_token = os.getenv( "DODO_API_KEY" )) class CheckoutRequest ( BaseModel ): product_id: str quantity: int @app.post ( "/create-checkout" ) async def create_checkout ( request : CheckoutRequest): try : session = await dodo.checkout_sessions.create( product_cart = [{ "product_id" : request.product_id, "quantity" : request.quantity }], return_url = "https://yourdomain.com/return" ) return { "checkout_url" : session.url} except Exception as e: raise HTTPException( status_code = 400 , detail = str (e)) Django from django.http import JsonResponse from dodopayments import DodoPayments import os dodo = DodoPayments( bearer_token = os.getenv( "DODO_API_KEY" )) def create_payment ( request ): try : payment = dodo.payments.create( amount = 5000 , currency = "USD" , customer_id = request.user.customer_id ) return JsonResponse({ "status" : "success" , "payment_id" : payment.id }) except Exception as e: return JsonResponse({ "status" : "error" , "message" : str (e) }, status = 400 ) リソース サポート Python SDKに関して助けが必要ですか？
貢献を歓迎します！始めるための貢献ガイドライン を確認してください。 
