Le SDK Kotlin fournit un accès pratique à l’API REST de Dodo Payments depuis des applications écrites en Kotlin. Il propose des valeurs nullables, des séquences, des fonctions suspendues et d’autres fonctionnalités spécifiques à Kotlin pour une utilisation ergonomique.
Installation Gradle (Kotlin DSL) Ajoutez la dépendance à votre build.gradle.kts :
implementation ( "com.dodopayments.api:dodo-payments-kotlin:1.61.5" ) Maven Ajoutez la dépendance à votre pom.xml :
< dependency > < groupId > com.dodopayments.api </ groupId > < artifactId > dodo-payments-kotlin </ artifactId > < version > 1.61.5 </ version > </ dependency > Utilisez toujours la dernière version du SDK pour accéder aux nouvelles fonctionnalités de Dodo Payments. Consultez Maven Central pour la dernière version. Le SDK nécessite Kotlin 1.6 ou supérieur et est compatible avec les plateformes JVM et Android.
Démarrage rapide Initialisez le client et créez une session de paiement :
import com.dodopayments.api.client.DodoPaymentsClient import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse // Configure using environment variables (DODO_PAYMENTS_API_KEY, DODO_PAYMENTS_BASE_URL) // Or system properties (dodopayments.apiKey, dodopayments.baseUrl) val client: DodoPaymentsClient = DodoPaymentsOkHttpClient. fromEnv () val params: CheckoutSessionRequest = CheckoutSessionRequest. builder () . addProductCart (CheckoutSessionRequest.ProductCart. builder () . productId ( "product_id" ) . quantity ( 1 ) . build ()) . build () val checkoutSessionResponse: CheckoutSessionResponse = client. checkoutSessions (). create (params) println (checkoutSessionResponse. sessionId ()) Stockez toujours vos clés API en toute sécurité en utilisant des variables d’environnement ou une configuration chiffrée. Ne les engagez jamais dans le contrôle de version.
Fonctionnalités principales
Coroutines Prise en charge complète des coroutines Kotlin pour les opérations asynchrones
Null Safety Profitez de la sécurité des nulls de Kotlin pour une gestion robuste des erreurs
Extension Functions Extensions idiomatiques de Kotlin pour une fonctionnalité améliorée
Data Classes Classes de données sûres avec prise en charge de la copie et de la déstructuration
Configuration À partir des variables d’environnement Initialisez à partir des variables d’environnement ou des propriétés système :
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient. fromEnv () Configuration manuelle Configurez manuellement avec toutes les options :
import java.time.Duration val client = DodoPaymentsOkHttpClient. builder () . bearerToken ( "your_api_key_here" ) . baseUrl ( "https://live.dodopayments.com" ) . maxRetries ( 3 ) . timeout (Duration. ofSeconds ( 30 )) . build () Mode test Configurez pour l’environnement de test/sandbox :
val testClient = DodoPaymentsOkHttpClient. builder () . fromEnv () . testMode () . build () Timeouts et réessais Configurez globalement ou par requête :
import com.dodopayments.api.core.RequestOptions // Global configuration val client = DodoPaymentsOkHttpClient. builder () . fromEnv () . timeout (Duration. ofSeconds ( 45 )) . maxRetries ( 3 ) . build () // Per-request timeout override val product = client. products (). retrieve ( "prod_123" , RequestOptions. builder () . timeout (Duration. ofSeconds ( 10 )) . build () ) Opérations courantes Créer une session de paiement Générez une session de paiement :
val params = CheckoutSessionRequest. builder () . addProductCart (CheckoutSessionRequest.ProductCart. builder () . productId ( "prod_123" ) . quantity ( 1 ) . build ()) . returnUrl ( "https://yourdomain.com/return" ) . build () val session = client. checkoutSessions (). create (params) println ( "Checkout URL: ${ session. url () } " ) Créer un produit Créez des produits avec une configuration détaillée :
import com.dodopayments.api.models.products.Product import com.dodopayments.api.models.products.ProductCreateParams import com.dodopayments.api.models.misc.Currency import com.dodopayments.api.models.misc.TaxCategory val createParams = ProductCreateParams. builder () . name ( "Premium Subscription" ) . description ( "Monthly subscription with all features" ) . price ( ProductCreateParams.RecurringPrice. builder () . currency (Currency.USD) . preTaxAmount ( 2999 ) // $29.99 in cents . paymentFrequencyInterval (ProductCreateParams.RecurringPrice.TimeInterval.MONTH) . paymentFrequencyCount ( 1 ) . build () ) . taxCategory (TaxCategory.DIGITAL_GOODS) . build () val product: Product = client. products (). create (createParams) println ( "Created product ID: ${ product. productId () } " ) Activer la clé de licence Activez les clés de licence pour les clients :
import com.dodopayments.api.models.licenses.LicenseActivateParams import com.dodopayments.api.models.licenses.LicenseActivateResponse val activateParams = LicenseActivateParams. builder () . licenseKey ( "XXXX-XXXX-XXXX-XXXX" ) . instanceName ( "user-laptop-01" ) . build () try { val activationResult: LicenseActivateResponse = client. licenses () . activate (activateParams) println ( "License activated successfully" ) println ( "Instance ID: ${ activationResult. instanceId () } " ) println ( "Expires at: ${ activationResult. expiresAt () } " ) } catch (e: UnprocessableEntityException ) { println ( "License activation failed: ${ e.message } " ) } Facturation basée sur l’utilisation Enregistrer des événements d’utilisation Suivez l’utilisation pour les compteurs :
import com.dodopayments.api.models.usageevents.UsageEventCreateParams import java.time.OffsetDateTime val usageParams = UsageEventCreateParams. builder () . meterId ( "meter_123" ) . customerId ( "cust_456" ) . value ( 150 ) . timestamp (OffsetDateTime. now ()) . build () client. usageEvents (). create (usageParams) println ( "Usage event recorded" ) Opérations asynchrones Client asynchrone Utilisez le client asynchrone pour des opérations basées sur des coroutines :
import com.dodopayments.api.client.DodoPaymentsClientAsync import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClientAsync import kotlinx.coroutines.runBlocking val asyncClient: DodoPaymentsClientAsync = DodoPaymentsOkHttpClientAsync. fromEnv () runBlocking { val customer = asyncClient. customers (). retrieve ( "cust_123" ) println ( "Customer email: ${ customer. email () } " ) } Gestion des erreurs Gérez les erreurs avec la gestion des exceptions de Kotlin :
import com.dodopayments.api.errors. * try { val payment = client. payments (). create (params) println ( "Success: ${ payment. id () } " ) } catch (e: AuthenticationException ) { println ( "Authentication failed: ${ e.message } " ) } catch (e: InvalidRequestException ) { println ( "Invalid request: ${ e.message } " ) e.parameter?. let { println ( "Parameter: $it " ) } } catch (e: RateLimitException ) { println ( "Rate limit exceeded, retry after: ${ e.retryAfter } " ) } catch (e: DodoPaymentsServiceException ) { println ( "API error: ${ e. statusCode () } - ${ e.message } " ) } Gestion fonctionnelle des erreurs Utilisez Result pour une gestion fonctionnelle des erreurs :
fun safeCreatePayment (client: DodoPaymentsClient ): Result < Payment > = runCatching { client. payments (). create (params) } // Usage safe CreatePayment (client) . onSuccess { payment -> println ( "Created: ${ payment. id () } " ) } . onFailure { error -> println ( "Error: ${ error.message } " ) } Utilisez runCatching de Kotlin pour une approche plus fonctionnelle de la gestion des erreurs avec des types Result.
Intégration Android Utilisez avec des applications Android :
import android.app.Application import androidx.lifecycle.ViewModel import androidx.lifecycle.viewModelScope import com.dodopayments.api.client.DodoPaymentsClient import kotlinx.coroutines.launch class PaymentViewModel (application: Application ) : ViewModel () { private val client = DodoPaymentsOkHttpClient. builder () . bearerToken (BuildConfig.DODO_API_KEY) . build () fun createCheckout (productId: String ) { viewModelScope. launch { try { val session = client. async (). checkoutSessions (). create (params) // Open checkout URL in browser or WebView openUrl (session. url ()) } catch (e: Exception ) { handleError (e) } } } } Validation des réponses Activez la validation des réponses :
import com.dodopayments.api.core.RequestOptions // Per-request validation val product = client. products (). retrieve ( "prod_123" , RequestOptions. builder () . responseValidation ( true ) . build () ) // Or validate explicitly val validatedProduct = product. validate () Fonctionnalités avancées Configuration du proxy Configurez les paramètres du proxy :
import java.net.InetSocketAddress import java.net.Proxy val client = DodoPaymentsOkHttpClient. builder () . fromEnv () . proxy ( Proxy ( Proxy.Type.HTTP, InetSocketAddress ( "proxy.example.com" , 8080 ) ) ) . build () Configuration temporaire Modifiez temporairement la configuration du client :
val customClient = client. withOptions { it. baseUrl ( "https://example.com" ) it. maxRetries ( 5 ) } Intégration Ktor Intégrez avec des applications serveur Ktor :
import io.ktor.server.application. * import io.ktor.server.request. * import io.ktor.server.response. * import io.ktor.server.routing. * fun Application . configureRouting () { val client = DodoPaymentsOkHttpClient. builder () . bearerToken (environment.config. property ( "dodo.apiKey" ). getString ()) . build () routing { post ( "/create-checkout" ) { try { val request = call. receive < CheckoutRequest >() val session = client. checkoutSessions (). create (params) call. respond ( mapOf ( "checkout_url" to session. url ())) } catch (e: DodoPaymentsServiceException ) { call. respond (HttpStatusCode.BadRequest, mapOf ( "error" to e.message)) } } } } Ressources Support Besoin d’aide avec le SDK Kotlin ?
Contribuer Nous accueillons les contributions ! Consultez les directives de contribution pour commencer. 
