Instalação
Instale o SDK usando seu gerenciador de pacotes de sua escolha:Início Rápido
Inicialize o cliente com sua chave de API e comece a processar pagamentos:Recursos Principais
TypeScript First
Suporte total a TypeScript com definições de tipo abrangentes para todos os endpoints da API
Auto-Paginação
Paginação automática para respostas de lista torna o trabalho com grandes conjuntos de dados sem esforço
Tratamento de Erros
Tipos de erro integrados com mensagens detalhadas para diferentes cenários de falha
Tentativas Inteligentes
Tentativas automáticas configuráveis com backoff exponencial para erros transitórios
Configuração
Variáveis de Ambiente
Defina variáveis de ambiente para configuração segura:.env
Configuração de Timeout
Configure timeouts de requisição globalmente ou por requisição: TODO: PLACEHOLDER_DE_CÓDIGO_d9422b829dcf570e0d6ea69d34928d6dConfiguração de Tentativas
Configure o comportamento de tentativas automáticas: TODO: PLACEHOLDER_DE_CÓDIGO_8ec75888d9859a1d5d88346864f4e8dbOperações Comuns
Criar uma Sessão de Checkout
Gere uma sessão de checkout para coletar informações de pagamento:Gerenciar Clientes
Crie e recupere informações de clientes:Gerenciar Assinaturas
Crie e gerencie assinaturas recorrentes:Cobrança Baseada em Uso
Ingestão de Eventos de Uso
Rastreie eventos personalizados para cobrança baseada em uso:Os eventos devem ter valores únicos de
event_id para idempotência. IDs duplicados dentro da mesma solicitação são rejeitados, e solicitações subsequentes com IDs existentes são ignoradas.Recuperar Eventos de Uso
Busque informações detalhadas sobre eventos de uso:Configuração de Proxy
Configure as configurações de proxy para diferentes ambientes de execução:Node.js (usando undici)
Bun
Deno
Registro
Controle a verbosidade do log usando variáveis de ambiente ou opções do cliente:'debug'- Mostrar mensagens de depuração, informações, avisos e erros'info'- Mostrar mensagens de informações, avisos e erros'warn'- Mostrar avisos e erros (padrão)'error'- Mostrar apenas erros'off'- Desativar todos os logs
Migração do SDK Node.js
Se você está atualizando do SDK Node.js legado, o SDK TypeScript oferece segurança de tipo e recursos aprimorados:Ver Guia de Migração
Aprenda como migrar do SDK Node.js para o SDK TypeScript
Auto-Paginação
Os métodos de listagem na API DodoPayments são paginados. Você pode usar a sintaxefor await … of para iterar através dos itens em todas as páginas:
TODO: PLACEHOLDER_DE_CÓDIGO_20831acc0088b6925fa9c28b685e3a40
Alternativamente, você pode solicitar uma única página por vez:
TODO: PLACEHOLDER_DE_CÓDIGO_87be751d1b2ac11515bd21053c8b98aa
Requisitos
Os seguintes ambientes de execução são suportados:- Navegadores da web (Chrome, Firefox, Safari, Edge e mais atualizados)
- Node.js 20 LTS ou versões posteriores (non-EOL)
- Deno v1.28.0 ou superior
- Bun 1.0 ou posterior
- Cloudflare Workers
- Vercel Edge Runtime
- Jest 28 ou superior com o ambiente
"node" - Nitro v2.6 ou superior
Recursos
Repositório do GitHub
Ver código-fonte e contribuir
Referência da API
Documentação completa da API
Comunidade do Discord
Obtenha ajuda e conecte-se com desenvolvedores
Relatar Problemas
Relate bugs ou solicite recursos
Suporte
Precisa de ajuda com o SDK TypeScript?- Discord: Junte-se ao nosso servidor da comunidade para suporte em tempo real
- Email: Entre em contato conosco pelo support@dodopayments.com
- GitHub: Abra um problema no repositório