Skip to main content
O SDK Ruby fornece uma maneira simples e intuitiva de integrar Dodo Payments em suas aplicações Ruby. Ele segue as convenções e melhores práticas do Ruby, oferecendo tratamento de erros abrangente, paginação e suporte a middleware.

Instalação

Adicione a gem ao seu Gemfile:
Gemfile
Sempre use a versão mais recente do SDK para acessar os recursos mais novos do Dodo Payments. Execute bundle update dodopayments regularmente para manter-se atualizado.
Em seguida, execute:
O SDK é compatível com Ruby 3.2.0 e versões posteriores, com tipos completos, tratamento de erros e mecanismos de retentativa.

Início Rápido

Inicialize o cliente e crie uma sessão de checkout:
Armazene suas chaves de API com segurança usando variáveis de ambiente. Nunca as commitie no controle de versão ou as exponha no código.

Recursos Principais

Ruby Conventions

Segue as convenções de nomenclatura do Ruby e padrões idiomáticos

Elegant Syntax

API limpa e legível que parece natural para desenvolvedores Ruby

Auto-Pagination

Iteradores de paginação automática integrados para respostas de listas

Type Safety

Tipos Sorbet opcionais para maior segurança de tipo

Configuração

Configuração de Timeout

Configure timeouts de requisição:

Configuração de Repetição

Configure o comportamento de repetição automática:

Operações Comuns

Criar uma Sessão de Checkout

Gere uma sessão de checkout:

Gerenciar Clientes

Crie e recupere informações de clientes:

Gerenciar Assinaturas

Crie e gerencie assinaturas recorrentes:
POST /subscriptions (o método subscriptions.create do SDK) está obsoleto. Ele ainda funciona para integrações existentes, mas novas integrações devem criar assinaturas por meio de uma Checkout Session.
billing requer, no mínimo, o código ISO de duas letras country. customer aceita { customer_id: "..." } para associar um customer existente ou { email: "...", name: "..." } para criar um novo. product_price está na menor denominação da moeda.

Paginação

Paginação automática

Itere automaticamente por todas as páginas:

Paginação manual

Para ter mais controle sobre a paginação:

Tratamento de erros

Trate vários erros da API do Dodo Payments:
Implemente uma lógica de novas tentativas com backoff exponencial para erros de limite de taxa, garantindo que sua aplicação lide adequadamente com cenários de alto volume.

Segurança de tipos com Sorbet

Use o Sorbet para obter parâmetros de solicitação com segurança de tipos:

Uso avançado

Endpoints não documentados

Faça solicitações para endpoints não documentados:

Parâmetros não documentados

Envie parâmetros não documentados:

Integração com Rails

Crie um inicializador

Crie config/initializers/dodo_payments.rb:

Padrão de objeto de serviço

Crie um serviço de pagamentos:

Integração com o controller

Use nos seus controllers do Rails:

Integração com Sinatra

Use com aplicações Sinatra:

Recursos

GitHub Repository

Veja o código-fonte e contribua

API Reference

Documentação completa da API

Discord Community

Obtenha ajuda e conecte-se com desenvolvedores

Report Issues

Relate bugs ou solicite recursos

Suporte

Precisa de ajuda com o Ruby SDK?

Contribuição

Adoramos receber contribuições! Consulte as diretrizes de contribuição para começar.
Última modificação em 17 de agosto de 2026