Zum Hauptinhalt springen
Das Ruby SDK bietet eine einfache und intuitive Möglichkeit, Dodo Payments in Ihre Ruby-Anwendungen zu integrieren. Es folgt den Ruby-Konventionen und Best Practices und bietet umfassende Fehlerbehandlung, Paginierung und Middleware-Unterstützung.

Installation

Fügen Sie das Gem zu Ihrer Gemfile hinzu:
Gemfile
gem "dodopayments", "~> 1.61.5"
Verwenden Sie immer die neueste SDK-Version, um auf die neuesten Funktionen von Dodo Payments zuzugreifen. Führen Sie bundle update dodopayments regelmäßig aus, um auf dem neuesten Stand zu bleiben.
Führen Sie dann aus:
bundle install
Das SDK unterstützt Ruby 3.2.0 und spätere Versionen mit umfassenden Typen, Fehlerbehandlung und Wiederholungsmechanismen.

Schnellstart

Initialisieren Sie den Client und erstellen Sie eine Checkout-Sitzung:
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)
Bewahren Sie Ihre API-Schlüssel sicher in Umgebungsvariablen auf. Kommittieren Sie sie niemals in die Versionskontrolle oder exponieren Sie sie in Ihrem Code.

Kernfunktionen

Ruby-Konventionen

Folgt den Ruby-Namenskonventionen und idiomatischen Mustern

Elegante Syntax

Saubere, lesbare API, die sich für Ruby-Entwickler natürlich anfühlt

Auto-Paginierung

Eingebaute Auto-Paging-Iteratoren für Listenantworten

Typensicherheit

Optionale Sorbet-Typen für verbesserte Typensicherheit

Konfiguration

Timeout-Konfiguration

Konfigurieren Sie die Anfrage-Timeouts:
# 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}
)

Wiederholungs-Konfiguration

Konfigurieren Sie das automatische Wiederholungsverhalten:
# 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}
)

Häufige Operationen

Erstellen einer Checkout-Sitzung

Generieren Sie eine Checkout-Sitzung:
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

Kunden verwalten

Erstellen und Abrufen von Kundeninformationen:
# 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})"

Abonnements verwalten

Erstellen und verwalten Sie wiederkehrende Abonnements:
# 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)

Paginierung

Auto-Paginierung

Automatisches Durchlaufen aller Seiten:
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

Manuelle Paginierung

Für mehr Kontrolle über die Paginierung:
page = dodo_payments.payments.list

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

Fehlerbehandlung

Behandeln Sie verschiedene Dodo Payments API-Fehler:
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
Implementieren Sie eine Wiederholungslogik mit exponentiellem Backoff für Ratenlimitfehler, um sicherzustellen, dass Ihre Anwendung hochvolumige Szenarien elegant behandelt.

Typensicherheit mit Sorbet

Verwenden Sie Sorbet für typensichere Anfrageparameter:
# 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)

Erweiterte Nutzung

Undokumentierte Endpunkte

Stellen Sie Anfragen an undokumentierte Endpunkte:
response = dodo_payments.request(
  method: :post,
  path: '/undocumented/endpoint',
  query: {"dog": "woof"},
  headers: {"useful-header": "interesting-value"},
  body: {"hello": "world"}
)

Undokumentierte Parameter

Senden Sie undokumentierte Parameter:
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])

Rails-Integration

Erstellen Sie einen Initializer

Erstellen Sie 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"
)

Service-Objekt-Muster

Erstellen Sie einen Zahlungsdienst:
# 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

Controller-Integration

Verwenden Sie es in Ihren Rails-Controllern:
# 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

Sinatra-Integration

Verwenden Sie es mit Sinatra-Anwendungen:
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

Ressourcen

Unterstützung

Brauchen Sie Hilfe mit dem Ruby SDK?

Mitwirken

Wir freuen uns über Beiträge! Überprüfen Sie die Mitwirkungsrichtlinien, um loszulegen.