El SDK de Python ofrece una interfaz Pythonic para la API de Dodo Payments, proporcionando tanto clientes síncronos como asíncronos con definiciones de tipo para solicitudes y respuestas. Es compatible con Python 3.7+ e incluye una cobertura de pruebas completa.
Instalación Instala el SDK usando pip:
Para un mejor rendimiento asíncrono con aiohttp:
pip install dodopayments[aiohttp] El SDK requiere Python 3.7 o superior. Recomendamos usar la última versión estable de Python para la mejor experiencia y actualizaciones de seguridad.
Inicio Rápido Cliente Síncrono 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) Cliente Asíncrono 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()) Siempre almacena tus claves API de forma segura utilizando variables de entorno. Nunca las comites en el control de versiones.
Características Principales
Interfaz Pythonic Código Python limpio e idiomático que sigue las pautas PEP 8 y las convenciones de Python
Async/Await Soporte completo para operaciones asíncronas con asyncio e integración opcional de aiohttp
Sugerencias de Tipo Sugerencias de tipo completas para mejor soporte de IDE y verificación de tipos con mypy
Auto-Paginación Paginación automática para respuestas de lista con iteración simple
Configuración Variables de Entorno Configura usando variables de entorno:
DODO_PAYMENTS_API_KEY = your_api_key_here Tiempos de Espera Configura los tiempos de espera de las solicitudes a nivel global o por solicitud:
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 , } ], ) Reintentos Configura el comportamiento de reintento automático:
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 , } ], ) Operaciones Comunes Crear una Sesión de Pago Genera una sesión de pago:
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 } " ) Gestionar Clientes Crea y recupera información de clientes:
# 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 } )" ) Manejar Suscripciones Crea y gestiona suscripciones recurrentes:
# 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" ) Facturación Basada en Uso Ingesta de Eventos de Uso Rastrea eventos personalizados para la facturación basada en uso:
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" } } ] ) Listar y Recuperar Eventos # 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 } " ) Paginación Auto-Paginación Itera a través de todos los elementos automáticamente:
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) Paginación Asíncrona 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()) Paginación Manual Para más control sobre la paginación:
# 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" ) Configuración del Cliente HTTP Personaliza el cliente subyacente 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" ), ), ) Async con aiohttp Usa aiohttp para un mejor rendimiento asíncrono:
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()) Registro Habilita el registro configurando la variable de entorno:
export DODO_PAYMENTS_LOG = info O para registro a nivel de depuración:
export DODO_PAYMENTS_LOG = debug Integración con Frameworks 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 ) Recursos Soporte ¿Necesitas ayuda con el SDK de Python?
Contribuyendo ¡Damos la bienvenida a las contribuciones! Consulta las directrices de contribución para comenzar. 
