Kotlin - Dodo Payments Documentation

Kotlin SDK ger bekväm åtkomst till Dodo Payments REST API från applikationer skrivna i Kotlin. Den har nullable-värden, Sequence, suspend-funktioner och andra Kotlin-specifika funktioner för ergonomisk användning.

Installation

Gradle (Kotlin DSL)

Lägg till beroendet i din build.gradle.kts:

build.gradle.kts

implementation("com.dodopayments.api:dodo-payments-kotlin:1.86.3")

Maven

Lägg till beroendet i din pom.xml:

pom.xml

<dependency>
  <groupId>com.dodopayments.api</groupId>
  <artifactId>dodo-payments-kotlin</artifactId>
  <version>1.86.3</version>
</dependency>

Använd alltid den senaste SDK-versionen för att få tillgång till de nyaste funktionerna i Dodo Payments. Kontrollera Maven Central för den senaste versionen.

SDK:et kräver Java 8 eller senare och är kompatibelt med både JVM- och Android-plattformar.

Snabbstart

Initiera klienten och skapa en checkout-session:

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionCreateParams
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest
import com.dodopayments.api.models.checkoutsessions.ProductItemReq

// 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(ProductItemReq.builder()
        .productId("product_id")
        .quantity(1)
        .build())
    .build()
    
val checkoutSessionResponse: CheckoutSessionResponse = client.checkoutSessions().create(params)
println(checkoutSessionResponse.sessionId())

Lagra alltid dina API-nycklar säkert med hjälp av miljövariabler eller krypterad konfiguration. Lägg dem aldrig i versionshantering.

Kärnfunktioner

Coroutines

Fullt stöd för Kotlin-korutiner för asynkrona operationer

Null Safety

Utnyttja Kotlins nullsäkerhet för robust felhantering

Extension Functions

Idiomatisk Kotlin-förlängning för förbättrad funktionalitet

Data Classes

Typsäkra dataklasser med stöd för kopiering och destrukturering

Konfiguration

Från miljövariabler

Initiera från miljövariabler eller systemegenskaper:

val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

Manuell konfiguration

Konfigurera manuellt med alla alternativ:

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()

Testläge

Konfigurera för Test Mode-miljön:

val testClient = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    .testMode()
    .build()

Tidsgränser och omförsök

Konfigurera globalt eller per begäran:

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(
    "pdt_123",
    RequestOptions.builder()
        .timeout(Duration.ofSeconds(10))
        .build()
)

Vanliga operationer

Skapa en checkout-session

Generera en checkout-session:

val params = CheckoutSessionRequest.builder()
    .addProductCart(ProductItemReq.builder()
        .productId("pdt_123")
        .quantity(1)
        .build())
    .returnUrl("https://yourdomain.com/return")
    .build()

val session = client.checkoutSessions().create(params)
println("Checkout URL: ${session.checkoutUrl()}")

Skapa en produkt

Skapa produkter med detaljerad konfiguration:

import com.dodopayments.api.models.products.Price
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
import com.dodopayments.api.models.misc.TimeInterval

val createParams = ProductCreateParams.builder()
    .name("Premium Subscription")
    .description("Monthly subscription with all features")
    .price(
        Price.RecurringPrice.builder()
            .currency(Currency.USD)
            .price(2999) // $29.99 in cents
            .discount(0L)
            .purchasingPowerParity(false)
            .paymentFrequencyCount(1)
            .paymentFrequencyInterval(TimeInterval.MONTH)
            .subscriptionPeriodCount(1)
            .subscriptionPeriodInterval(TimeInterval.MONTH)
            .build()
    )
    .taxCategory(TaxCategory.DIGITAL_PRODUCTS)
    .build()

val product: Product = client.products().create(createParams)
println("Created product ID: ${product.productId()}")

Aktivera licensnyckel

Aktivera licensnycklar för kunder:

import com.dodopayments.api.models.licenses.LicenseActivateParams
import com.dodopayments.api.models.licenses.LicenseActivateResponse

val activateParams = LicenseActivateParams.builder()
    .licenseKey("XXXX-XXXX-XXXX-XXXX")
    .name("user-laptop-01")
    .build()

try {
    val activationResult: LicenseActivateResponse = client.licenses()
        .activate(activateParams)

    println("License activated successfully")
    println("Instance ID: ${activationResult.id()}")
    println("License key ID: ${activationResult.licenseKeyId()}")
} catch (e: UnprocessableEntityException) {
    println("License activation failed: ${e.message}")
}

Användningsbaserad fakturering

Registrera användningsevenemang

POST /subscriptions (SDK:ns subscriptions.create-metod) är föråldrad. Den fungerar fortfarande för befintliga integrationer, men nya integrationer bör skapa prenumerationer via en Checkout Session.

import com.dodopayments.api.models.payments.AttachExistingCustomer
import com.dodopayments.api.models.payments.BillingAddress
import com.dodopayments.api.models.misc.CountryCode
import com.dodopayments.api.models.subscriptions.SubscriptionChargeParams
import com.dodopayments.api.models.subscriptions.SubscriptionCreateParams

// Create a subscription
val subscriptionParams = SubscriptionCreateParams.builder()
    .billing(BillingAddress.builder()
        .city("San Francisco")
        .country(CountryCode.US)
        .state("CA")
        .street("1 Market St")
        .zipcode("94105")
        .build())
    .customer(AttachExistingCustomer.builder()
        .customerId("cus_123")
        .build())
    .productId("pdt_456")
    .quantity(1)
    .build()

val subscription = client.subscriptions().create(subscriptionParams)
println("Subscription ID: ${subscription.subscriptionId()}")

// Charge an on-demand subscription
// productPrice is in the lowest currency denomination (e.g., 2500 = $25.00 USD)
val chargeParams = SubscriptionChargeParams.builder()
    .subscriptionId(subscription.subscriptionId())
    .productPrice(2500)
    .build()

val chargeResponse = client.subscriptions().charge(chargeParams)
println("Payment ID: ${chargeResponse.paymentId()}")

billing kräver minst en tvåbokstavs ISO country-kod. Använd AttachExistingCustomer för att koppla en befintlig kund, eller NewCustomer för att skapa en. productPrice anges i den lägsta valutaenheten.

Förbrukningsbaserad fakturering

Registrera användningshändelser

Spåra användning för mätare:

import com.dodopayments.api.models.usageevents.EventInput
import com.dodopayments.api.models.usageevents.UsageEventIngestParams

val usageParams = UsageEventIngestParams.builder()
    .addEvent(EventInput.builder()
        .customerId("cust_456")
        .eventId("event_123")
        .eventName("api_call")
        .build())
    .build()

client.usageEvents().ingest(usageParams)
println("Usage event recorded")

Asynkrona åtgärder

Asynkront klientbibliotek

Använd det asynkrona klientbiblioteket för coroutine-baserade åtgärder:

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()}")
}

Felhantering

Hantera fel med Kotlins undantagshantering:

import com.dodopayments.api.errors.*

try {
    val payment = client.payments().create(params)
    println("Success: ${payment.paymentId()}")
} 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}")
}

Funktionell felhantering

Använd Result för funktionell felhantering:

fun safeCreatePayment(client: DodoPaymentsClient): Result<Payment> = runCatching {
    client.payments().create(params)
}

// Usage
safeCreatePayment(client)
    .onSuccess { payment -> println("Created: ${payment.paymentId()}") }
    .onFailure { error -> println("Error: ${error.message}") }

Använd Kotlins runCatching för ett mer funktionellt sätt att hantera fel med Result-typer.

Android-integration

Använd med Android-applikationer:

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.checkoutUrl())
            } catch (e: Exception) {
                handleError(e)
            }
        }
    }
}

Svar validering

Aktivera svarsvalidering:

import com.dodopayments.api.core.RequestOptions

// Per-request validation
val product = client.products().retrieve(
    "pdt_123",
    RequestOptions.builder()
        .responseValidation(true)
        .build()
)

// Or validate explicitly
val validatedProduct = product.validate()

Avancerade funktioner

Proxykonfiguration

Konfigurera proxyinställningar:

import java.net.InetSocketAddress
import java.net.Proxy

val client = DodoPaymentsOkHttpClient.builder()
    .fromEnv()
    .proxy(
        Proxy(
            Proxy.Type.HTTP,
            InetSocketAddress("proxy.example.com", 8080)
        )
    )
    .build()

Tillfällig konfiguration

Ändra klientkonfigurationen tillfälligt:

val customClient = client.withOptions {
    it.baseUrl("https://example.com")
    it.maxRetries(5)
}

Ktor-integration

Integrera med Ktor-serverapplikationer:

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.checkoutUrl()))
            } catch (e: DodoPaymentsServiceException) {
                call.respond(HttpStatusCode.BadRequest, mapOf("error" to e.message))
            }
        }
    }
}

Resurser

GitHub Repository

Visa källkoden och bidra

API Reference

Fullständig API-dokumentation

Discord Community

Få hjälp och få kontakt med utvecklare

Report Issues

Rapportera buggar eller föreslå funktioner

Support

Behöver du hjälp med Kotlin SDK?

Discord: Gå med i vår communityserver för support i realtid
E-post: Kontakta oss på support@dodopayments.com
GitHub: Skapa ett ärende i kodförrådet

Bidra

Vi välkomnar bidrag! Läs riktlinjerna för bidrag för att komma igång.

​Installation

​Gradle (Kotlin DSL)

​Maven

​Snabbstart

​Kärnfunktioner

Coroutines

Null Safety

Extension Functions

Data Classes

​Konfiguration

​Från miljövariabler

​Manuell konfiguration

​Testläge

​Tidsgränser och omförsök

​Vanliga operationer

​Skapa en checkout-session

​Skapa en produkt

​Aktivera licensnyckel

​Användningsbaserad fakturering

​Registrera användningsevenemang

​Förbrukningsbaserad fakturering

​Registrera användningshändelser

​Asynkrona åtgärder

​Asynkront klientbibliotek

​Felhantering

​Funktionell felhantering

​Android-integration

​Svar validering

​Avancerade funktioner

​Proxykonfiguration

​Tillfällig konfiguration

​Ktor-integration

​Resurser

GitHub Repository

API Reference

Discord Community

Report Issues

​Support

​Bidra

Installation

Gradle (Kotlin DSL)

Maven

Snabbstart

Kärnfunktioner

Konfiguration

Från miljövariabler

Manuell konfiguration

Testläge

Tidsgränser och omförsök

Vanliga operationer

Skapa en checkout-session

Skapa en produkt

Aktivera licensnyckel

Användningsbaserad fakturering

Registrera användningsevenemang

Förbrukningsbaserad fakturering

Registrera användningshändelser

Asynkrona åtgärder

Asynkront klientbibliotek

Felhantering

Funktionell felhantering

Android-integration

Svar validering

Avancerade funktioner

Proxykonfiguration

Tillfällig konfiguration

Ktor-integration

Resurser

Support

Bidra