SDKs & Libraries
SDKs oficiais de backend para TypeScript, Python, Go, PHP, Java, Kotlin, C#, Ruby e Rust. Essas bibliotecas cuidam da autenticação, serialização e tratamento de erros para que você possa se concentrar na sua integração.
Mobile Checkout SDKs
Abra o checkout hospedado do Dodo em aplicativos Android, iOS, React Native e Flutter e obtenha um resultado tipado em uma única chamada. Esses SDKs não armazenam nenhuma chave de API.
URLs de ambiente
- Modo de teste:
https://test.dodopayments.com - Modo de produção:
https://live.dodopayments.com
Saiba mais sobre Modo de teste vs Modo ativo.
Autenticação
Todas as solicitações à API exigem uma chave de API. Gere uma no seu dashboard e inclua-a no cabeçalhoAuthorization de todas as solicitações.
1
Generate an API Key
Acesse Developer → API Keys no seu dashboard e selecione Add API Key. Crie a chave no modo que deseja usar: uma chave do modo de teste funciona somente com
https://test.dodopayments.com, e uma chave do modo de produção funciona somente com https://live.dodopayments.com. Dê à chave um nome descritivo e escolha seu nível de acesso:- Enable write access marcada (padrão): permissões completas de leitura e gravação para todas as operações da API.
- Enable write access desmarcada: acesso somente leitura. Você pode buscar dados (pagamentos, assinaturas, clientes, produtos), mas não pode criar ou modificar recursos.
2
Store Your Key Securely
Copie a chave imediatamente. Você não poderá vê-la novamente. Armazene-a em uma variável de ambiente, como
DODO_PAYMENTS_API_KEY.3
Authenticate Requests
Inclua sua chave de API no cabeçalho
Authorization de todas as solicitações:Formato da resposta
As solicitações bem-sucedidas retornam200 ou 201 com um corpo JSON, ou 204 sem corpo. Os erros retornam um status 4xx ou 5xx com um corpo JSON que contém um code e um message.
Limites de taxa
A API aplica dois limites simultaneamente: um limite de picos por segundo e um limite sustentado por minuto. Os limites se aplicam à sua empresa como um todo, em todas as suas chaves de API, e dependem do nível de limite de taxa da sua empresa.Nível padrão
Níveis superiores
Empresas com necessidades maiores de API podem fazer upgrade para limites de taxa superiores:Solicitações não autenticadas
As solicitações sem uma chave de API válida têm o limite de taxa definido pelo endereço IP:Cabeçalhos de limite de taxa
As respostas incluem cabeçalhos que mostram seu uso atual:X-RateLimit-Limit— Número máximo de solicitações permitidas na janela atual.X-RateLimit-Remaining— Solicitações restantes antes de atingir o limite.X-RateLimit-Reset— Segundos até a redefinição da janela atual.
429 Too Many Requests. Implemente um backoff exponencial na sua lógica de novas tentativas.
Tratamento de erros
Para descobrir o significado de um erro e como resolvê-lo, consulte as páginas de códigos de erro e falhas de transações.Error Codes
Lista completa de códigos de erro e seus significados.
Transaction Failures
Problemas comuns de transações e como lidar com eles.
Webhooks
Receba notificações em tempo real quando pagamentos, assinaturas e outros eventos ocorrerem. Configure webhooks no seu dashboard e processe os eventos necessários para sua integração.Webhook Guide
Configure webhooks, processe eventos e verifique assinaturas.
Guias de integração
Comece com um destes guias para criar sua primeira integração:One-time Payments
Crie sessões de checkout e links de pagamento e processe pagamentos.
Subscriptions
Configure o faturamento recorrente, gerencie planos e processe eventos do ciclo de vida.
Usage-Based Billing
Mensure o uso e cobre os clientes com base no consumo.
Checkout Sessions
Crie experiências de checkout hospedadas e seguras.