Saltar al contenido principal
El SDK de Ruby proporciona una forma simple e intuitiva de integrar Dodo Payments en tus aplicaciones Ruby. Sigue las convenciones y mejores prácticas de Ruby, ofreciendo un manejo de errores completo, paginación y soporte para middleware.

​
Instalación

Agrega la gema a tu Gemfile:
Gemfile
gem "dodopayments", "~> 1.61.5"
Siempre usa la última versión del SDK para acceder a las nuevas características de Dodo Payments. Ejecuta bundle update dodopayments regularmente para mantenerte actualizado.
Luego ejecuta: 
bundle install
El SDK es compatible con Ruby 3.2.0 y versiones posteriores, con tipos completos, manejo de errores y mecanismos de reintento.

​
Inicio Rápido

Inicializa el cliente y crea una sesión de pago: 
require "bundler/setup"
require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: ENV["DODO_PAYMENTS_API_KEY"], # This is the default and can be omitted
  environment: "test_mode" # defaults to "live_mode"
)

checkout_session_response = dodo_payments.checkout_sessions.create(
  product_cart: [{product_id: "product_id", quantity: 1}]
)

puts(checkout_session_response.session_id)
Almacena tus claves API de forma segura utilizando variables de entorno. Nunca las comites en el control de versiones ni las expongas en tu código.

​
Características Principales

Convenciones de Ruby

Sigue las convenciones de nomenclatura y patrones idiomáticos de Ruby

Sintaxis Elegante

API limpia y legible que se siente natural para los desarrolladores de Ruby

Auto-Paginación

Iteradores de paginación automática integrados para respuestas de lista

Seguridad de Tipos

Tipos opcionales de Sorbet para una mayor seguridad de tipos

​
Configuración

​
Configuración de Tiempo de Espera

Configura los tiempos de espera de las solicitudes: 
# Configure default for all requests (default is 60 seconds)
dodo_payments = Dodopayments::Client.new(
  timeout: nil # disable timeout
)

# Or, configure per-request
dodo_payments.checkout_sessions.create(
  product_cart: [{product_id: "product_id", quantity: 0}],
  request_options: {timeout: 5}
)

​
Configuración de Reintentos

Configura el comportamiento de reintento automático: 
# Configure default for all requests (default is 2)
dodo_payments = Dodopayments::Client.new(
  max_retries: 0 # disable retries
)

# Or, configure per-request
dodo_payments.checkout_sessions.create(
  product_cart: [{product_id: "product_id", quantity: 0}],
  request_options: {max_retries: 5}
)

​
Operaciones Comunes

​
Crear una Sesión de Pago

Genera una sesión de pago: 
session = dodo_payments.checkout_sessions.create(
  product_cart: [
    {
      product_id: "prod_123",
      quantity: 1
    }
  ],
  return_url: "https://yourdomain.com/return"
)

# Redirect to checkout
redirect_to session.url

​
Gestionar Clientes

Crea y recupera información de clientes: 
# Create a customer
customer = dodo_payments.customers.create(
  email: "[email protected]",
  name: "John Doe",
  metadata: {
    user_id: "12345"
  }
)

# Retrieve customer
customer = dodo_payments.customers.retrieve("cus_123")
puts "Customer: #{customer.name} (#{customer.email})"

​
Manejar Suscripciones

Crea y gestiona suscripciones recurrentes: 
# Create a subscription
subscription = dodo_payments.subscriptions.create(
  customer_id: "cus_123",
  product_id: "prod_456",
  price_id: "price_789"
)

# Update subscription
updated = dodo_payments.subscriptions.update(
  subscription.id,
  metadata: { plan_type: "premium" }
)

# Cancel subscription
dodo_payments.subscriptions.cancel(subscription.id)

​
Paginación

​
Auto-Paginación

Itera automáticamente a través de todas las páginas: 
page = dodo_payments.payments.list

# Fetch single item from page
payment = page.items[0]
puts(payment.brand_id)

# Automatically fetches more pages as needed
page.auto_paging_each do |payment|
  puts(payment.brand_id)
end

​
Paginación Manual

Para más control sobre la paginación: 
page = dodo_payments.payments.list

if page.next_page?
  new_page = page.next_page
  puts(new_page.items[0].brand_id)
end

​
Manejo de Errores

Maneja varios errores de la API de Dodo Payments: 
begin
  checkout_session = dodo_payments.checkout_sessions.create(
    product_cart: [{product_id: "product_id", quantity: 0}]
  )
rescue Dodopayments::Errors::APIConnectionError => e
  puts("The server could not be reached")
  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
rescue Dodopayments::Errors::RateLimitError => e
  puts("A 429 status code was received; we should back off a bit.")
rescue Dodopayments::Errors::APIStatusError => e
  puts("Another non-200-range status code was received")
  puts(e.status)
end
Implementa lógica de reintento con retroceso exponencial para errores de límite de tasa para asegurar que tu aplicación maneje escenarios de alto volumen de manera adecuada.

​
Seguridad de Tipos con Sorbet

Usa Sorbet para parámetros de solicitud seguros en tipos: 
# Type-safe using Sorbet RBI definitions
dodo_payments.checkout_sessions.create(
  product_cart: [
    Dodopayments::CheckoutSessionRequest::ProductCart.new(
      product_id: "product_id",
      quantity: 0
    )
  ]
)

# Hashes work, but are not typesafe
dodo_payments.checkout_sessions.create(
  product_cart: [{product_id: "product_id", quantity: 0}]
)

# You can also splat a full Params class
params = Dodopayments::CheckoutSessionCreateParams.new(
  product_cart: [
    Dodopayments::CheckoutSessionRequest::ProductCart.new(
      product_id: "product_id",
      quantity: 0
    )
  ]
)
dodo_payments.checkout_sessions.create(**params)

​
Uso Avanzado

​
Puntos Finales No Documentados

Realiza solicitudes a puntos finales no documentados: 
response = dodo_payments.request(
  method: :post,
  path: '/undocumented/endpoint',
  query: {"dog": "woof"},
  headers: {"useful-header": "interesting-value"},
  body: {"hello": "world"}
)

​
Parámetros No Documentados

Envía parámetros no documentados: 
checkout_session_response = dodo_payments.checkout_sessions.create(
  product_cart: [{product_id: "product_id", quantity: 0}],
  request_options: {
    extra_query: {my_query_parameter: value},
    extra_body: {my_body_parameter: value},
    extra_headers: {"my-header": value}
  }
)

# Access undocumented response properties
puts(checkout_session_response[:my_undocumented_property])

​
Integración con Rails

​
Crea un Inicializador

Crea config/initializers/dodo_payments.rb: 
require "dodopayments"

DODO_CLIENT = Dodopayments::Client.new(
  bearer_token: Rails.application.credentials.dodo_api_key,
  environment: Rails.env.production? ? "live_mode" : "test_mode"
)

​
Patrón de Objeto de Servicio

Crea un servicio de pago: 
# app/services/payment_service.rb
class PaymentService
  def initialize
    @client = DODO_CLIENT
  end

  def create_checkout(items)
    @client.checkout_sessions.create(
      product_cart: items,
      return_url: Rails.application.routes.url_helpers.checkout_return_url
    )
  end

  def process_payment(amount:, currency:, customer_id:)
    @client.payments.create(
      amount: amount,
      currency: currency,
      customer_id: customer_id
    )
  end
end

​
Integración en Controladores

Usa en tus controladores de Rails: 
# app/controllers/checkouts_controller.rb
class CheckoutsController < ApplicationController
  def create
    service = PaymentService.new
    session = service.create_checkout(checkout_params[:items])
    
    redirect_to session.url, allow_other_host: true
  rescue Dodopayments::Errors::APIError => e
    flash[:error] = "Payment error: #{e.message}"
    redirect_to cart_path
  end

  private

  def checkout_params
    params.require(:checkout).permit(items: [:product_id, :quantity])
  end
end

​
Integración con Sinatra

Usa con aplicaciones Sinatra: 
require "sinatra"
require "dodopayments"

configure do
  set :dodo_client, Dodopayments::Client.new(
    bearer_token: ENV["DODO_API_KEY"]
  )
end

post "/create-checkout" do
  content_type :json
  
  begin
    session = settings.dodo_client.checkout_sessions.create(
      product_cart: JSON.parse(request.body.read)["items"],
      return_url: "#{request.base_url}/return"
    )
    
    { checkout_url: session.url }.to_json
  rescue Dodopayments::Errors::APIError => e
    status 400
    { error: e.message }.to_json
  end
end

​
Recursos

Repositorio de GitHub

Ver el código fuente y contribuir

Referencia de API

Documentación completa de la API

Comunidad de Discord

Obtén ayuda y conéctate con desarrolladores

Reportar Problemas

Reporta errores o solicita características

​
Soporte

¿Necesitas ayuda con el SDK de Ruby?

​
Contribuyendo

¡Damos la bienvenida a las contribuciones! Consulta las directrices de contribución para comenzar.