Référence de l’API - Dodo Payments Documentation

SDKs & Libraries

SDK backend officiels pour TypeScript, Python, Go, PHP, Java, Kotlin, C#, Ruby et Rust. Ces bibliothèques gèrent l’authentification, la sérialisation et la gestion des erreurs afin que vous puissiez vous concentrer sur votre intégration.

Mobile Checkout SDKs

Ouvrez le checkout hébergé de Dodo depuis des applications Android, iOS, React Native et Flutter, puis obtenez un résultat typé en un seul appel. Ces SDK ne contiennent aucune clé API.

URL d’environnement

Mode test : https://test.dodopayments.com
Mode live : https://live.dodopayments.com

Pour en savoir plus, consultez Mode test ou mode réel.

Authentification

Les requêtes API nécessitent une clé API, à l’exception de quelques endpoints publics tels que Activer une licence, Valider une licence et Désactiver une licence. Générez-en une dans votre tableau de bord et incluez-la dans l’en-tête Authorization de chaque requête.

Generate an API Key

Accédez à Developer → API Keys dans votre dashboard et sélectionnez Add API Key. Créez la clé dans le mode que vous souhaitez appeler : une clé de mode test fonctionne uniquement avec https://test.dodopayments.com, tandis qu’une clé de mode live fonctionne uniquement avec https://live.dodopayments.com. Donnez à la clé un nom descriptif et choisissez votre niveau d’accès :

Enable write access cochée (par défaut) : autorisations complètes de lecture et d’écriture pour toutes les opérations API.
Enable write access décochée : accès en lecture seule. Vous pouvez récupérer des données (paiements, abonnements, clients, produits), mais vous ne pouvez pas créer ni modifier de ressources.

Décochez Enable write access pour les intégrations qui ont uniquement besoin de consulter des données, comme les outils d’analyse ou les intégrations de dashboard.

Store Your Key Securely

Copiez immédiatement la clé. Vous ne pourrez plus la voir ensuite. Stockez-la dans une variable d’environnement telle que DODO_PAYMENTS_API_KEY.

Authenticate Requests

Incluez votre clé API dans l’en-tête Authorization de chaque requête :

Authorization: Bearer YOUR_API_KEY

N’exposez jamais votre clé API dans du code côté client, des dépôts publics ou un système de contrôle de version.

Format de réponse

Les requêtes réussies renvoient 200 ou 201 avec un corps JSON, ou 204 sans corps. Les erreurs renvoient un statut 4xx ou 5xx avec un corps JSON contenant un code et un message.

{
  "payment_id": "pay_gr4RizvMOXFJ6xca3y2tU",
  "status": "succeeded",
  "total_amount": 2999,
  "currency": "USD",
  "created_at": "2024-01-15T10:30:00Z"
}

{
  "code": "INVALID_REQUEST_BODY",
  "message": "Your request body is invalid. Please check your request headers and object."
}

Limites de débit

L’API applique simultanément deux limites : une limite de rafale par seconde et une limite soutenue par minute. Les limites s’appliquent à l’ensemble de votre entreprise, pour toutes ses clés API, et dépendent de son niveau de limite de débit.

Niveau par défaut

Fenêtre	Limite
Par seconde (rafale)	40 requêtes
Par minute (soutenue)	240 requêtes

Niveaux supérieurs

Les entreprises ayant des besoins API plus importants peuvent passer à des limites de débit supérieures :

Niveau	Rafale (par seconde)	Soutenue (par minute)
Par défaut	40	240
Niveau 1	100	1 000
Niveau 2	500	5 000

Pour augmenter votre niveau de limite de débit, envoyez un e-mail à support@dodopayments.com.

Requêtes non authentifiées

Les requêtes sans clé API valide sont limitées en fonction de l’adresse IP :

Fenêtre	Limite
Par seconde (rafale)	20 requêtes
Par minute (soutenue)	100 requêtes

En-têtes de limite de débit

Les réponses incluent des en-têtes qui indiquent votre utilisation actuelle :

X-RateLimit-Limit — Nombre maximal de requêtes autorisées dans la fenêtre actuelle.
X-RateLimit-Remaining — Nombre de requêtes restantes avant d’atteindre la limite.
X-RateLimit-Reset — Nombre de secondes avant la réinitialisation de la fenêtre actuelle.

Lorsque vous dépassez la limite, l’API renvoie 429 Too Many Requests. Implémentez un backoff exponentiel dans votre logique de nouvelle tentative.

Gestion des erreurs

Pour comprendre la signification d’une erreur et savoir comment la résoudre, consultez les pages consacrées aux codes d’erreur et aux échecs de transaction.

Error Codes

Liste complète des codes d’erreur et de leur signification.

Transaction Failures

Problèmes de transaction courants et moyens de les gérer.

Webhooks

Recevez des notifications en temps réel lorsque des paiements, des abonnements et d’autres événements se produisent. Configurez les webhooks dans votre dashboard et gérez les événements dont votre intégration a besoin.

Webhook Guide

Configurez les webhooks, gérez les événements et vérifiez les signatures.

Guides d’intégration

Commencez par l’un de ces guides pour créer votre première intégration :

One-time Payments

Créez des sessions de checkout et des liens de paiement, puis gérez les paiements.

Subscriptions

Configurez la facturation récurrente, gérez les plans et gérez les événements du cycle de vie.

Usage-Based Billing

Mesurez l’utilisation et facturez les clients en fonction de leur consommation.

Checkout Sessions

Créez des expériences de checkout sécurisées et hébergées.

SDKs & Libraries

Mobile Checkout SDKs

​URL d’environnement

​Authentification

​Format de réponse

​Limites de débit

​Niveau par défaut

​Niveaux supérieurs

​Requêtes non authentifiées

​En-têtes de limite de débit

​Gestion des erreurs

Error Codes

Transaction Failures

​Webhooks

Webhook Guide

​Guides d’intégration

One-time Payments

Subscriptions

Usage-Based Billing

Checkout Sessions

URL d’environnement

Authentification

Format de réponse

Limites de débit

Niveau par défaut

Niveaux supérieurs

Requêtes non authentifiées

En-têtes de limite de débit

Gestion des erreurs

Webhooks

Guides d’intégration