Go - Dodo Payments Documentation

Das Go SDK bietet eine saubere und idiomatische Go-Schnittstelle zur Integration von Dodo Payments in Ihre Anwendungen. Es bietet Unterstützung für Kontexte, stark typisierte Antworten, Middleware-Funktionen und ist sicher für die gleichzeitige Nutzung.

Installation

Installieren Sie das SDK mit Go-Modulen:

go get github.com/dodopayments/dodopayments-go

Oder um auf eine bestimmte Version zu verweisen:

go get -u 'github.com/dodopayments/dodopayments-go@v1.97.3'

Das SDK erfordert Go 1.22 oder neuere Versionen und nutzt moderne Go-Funktionen für optimale Leistung.

Schnellstart

Initialisieren Sie den Client und erstellen Sie Ihre erste Checkout-Sitzung:

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"), // defaults to os.LookupEnv("DODO_PAYMENTS_API_KEY")
		option.WithEnvironmentTestMode(),          // defaults to option.WithEnvironmentLiveMode()
	)
	
	checkoutSessionResponse, err := client.CheckoutSessions.New(context.TODO(), dodopayments.CheckoutSessionNewParams{
		CheckoutSessionRequest: dodopayments.CheckoutSessionRequestParam{
			ProductCart: dodopayments.F([]dodopayments.ProductItemReqParam{{
				ProductID: dodopayments.F("product_id"),
				Quantity:  dodopayments.F(int64(1)),
			}}),
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("Session ID: %s\n", checkoutSessionResponse.SessionID)
}

Speichern Sie Ihre API-Schlüssel immer sicher über Umgebungsvariablen. Hardcodieren Sie sie niemals im Quellcode.

Kernfunktionen

Context Support

Vollständige Unterstützung für context.Context bei Kündigungen und Zeitüberschreitungen

Strong Typing

Stark typisierte Anfragen und Antworten für Kompilierzeitsicherheit

Middleware

Erweiterbare Middleware-Unterstützung für Logging, Metriken und benutzerdefinierte Logik

Goroutine Safe

Thread-sicherer Client für gleichzeitige Operationen entwickelt

Konfiguration

Kontext und Zeitüberschreitungen

Nutzen Sie den Kontext von Go für Zeitüberschreitungen und Abbrüche:

import (
	"context"
	"time"
	
	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

// Create a context with timeout
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()

payment, err := client.Payments.New(ctx, dodopayments.PaymentNewParams{
	Billing: dodopayments.F(dodopayments.BillingAddressParam{
		Country: dodopayments.F(dodopayments.CountryCodeUs),
		City:    dodopayments.F("San Francisco"),
		State:   dodopayments.F("CA"),
		Street:  dodopayments.F("1 Market St"),
		Zipcode: dodopayments.F("94105"),
	}),
	Customer: dodopayments.F[dodopayments.CustomerRequestUnionParam](
		dodopayments.AttachExistingCustomerParam{
			CustomerID: dodopayments.F("cus_123"),
		},
	),
	ProductCart: dodopayments.F([]dodopayments.OneTimeProductCartItemParam{{
		ProductID: dodopayments.F("pdt_456"),
		Quantity:  dodopayments.F(int64(1)),
	}}),
})
if err != nil {
	if ctx.Err() == context.DeadlineExceeded {
		log.Println("Request timed out")
	} else {
		log.Fatal(err)
	}
}

Wiederholungs-Konfiguration

Konfigurieren Sie das automatische Wiederholungsverhalten:

// Configure default for all requests (default is 2)
client := dodopayments.NewClient(
	option.WithMaxRetries(0), // disable retries
)

// Override per-request
client.CheckoutSessions.New(
	context.TODO(),
	dodopayments.CheckoutSessionNewParams{
		CheckoutSessionRequest: dodopayments.CheckoutSessionRequestParam{
			ProductCart: dodopayments.F([]dodopayments.ProductItemReqParam{{
				ProductID: dodopayments.F("product_id"),
				Quantity:  dodopayments.F(int64(0)),
			}}),
		},
	},
	option.WithMaxRetries(5),
)

Häufige Operationen

Erstellen einer Checkout-Sitzung

Generieren Sie eine Checkout-Sitzung:

session, err := client.CheckoutSessions.New(ctx, dodopayments.CheckoutSessionNewParams{
	CheckoutSessionRequest: dodopayments.CheckoutSessionRequestParam{
		ProductCart: dodopayments.F([]dodopayments.ProductItemReqParam{{
			ProductID: dodopayments.F("pdt_123"),
			Quantity:  dodopayments.F(int64(1)),
		}}),
		ReturnURL: dodopayments.F("https://yourdomain.com/return"),
	},
})
if err != nil {
	log.Fatal(err)
}

fmt.Printf("Checkout URL: %s\n", session.CheckoutURL)

Kunden verwalten

Erstellen und Abrufen von Kundeninformationen:

// Create a customer
customer, err := client.Customers.New(ctx, dodopayments.CustomerNewParams{
	Email: dodopayments.F("customer@example.com"),
	Name:  dodopayments.F("John Doe"),
	Metadata: dodopayments.F(map[string]string{
		"user_id": "12345",
	}),
})
if err != nil {
	log.Fatal(err)
}

// Retrieve customer
customer, err = client.Customers.Get(ctx, "cus_123")
if err != nil {
	log.Fatal(err)
}

fmt.Printf("Customer: %s (%s)\n", customer.Name, customer.Email)

Abonnements verwalten

Erstellen und verwalten Sie wiederkehrende Abonnements:

POST /subscriptions (die subscriptions.create-Methode des SDK) ist veraltet. Sie funktioniert weiterhin für bestehende Integrationen, aber neue Integrationen sollten Abonnements über eine Checkout Session erstellen.

CODE_PLACEHOLDER_7a13122d7e975a0_END

Billing erfordert mindestens den zweistelligen ISO-Country-Code. Customer ist ein CustomerRequestUnionParam — übergib AttachExistingCustomerParam{CustomerID: ...} für einen bestehenden Kunden oder NewCustomerParam{Email: ..., Name: ...} für einen neuen Kunden. ProductPrice wird in der kleinsten Währungseinheit angegeben.

Nutzungsbasierte Abrechnung

Nutzungsereignisse erfassen

Benutzerdefinierte Ereignisse erfassen:

import "github.com/dodopayments/dodopayments-go"

response, err := client.UsageEvents.Ingest(ctx, dodopayments.UsageEventIngestParams{
	Events: dodopayments.F([]dodopayments.EventInputParam{{
		EventID:    dodopayments.F("api_call_12345"),
		CustomerID: dodopayments.F("cus_abc123"),
		EventName:  dodopayments.F("api_request"),
		Timestamp:  dodopayments.F(time.Date(2024, 1, 15, 10, 30, 0, 0, time.UTC)),
	}}),
})
if err != nil {
	log.Fatal(err)
}

Nutzungsereignisse auflisten

// List events with filters
params := dodopayments.UsageEventListParams{
	CustomerID: dodopayments.F("cus_abc123"),
	EventName:  dodopayments.F("api_request"),
}

events, err := client.UsageEvents.List(ctx, params)
if err != nil {
	log.Fatal(err)
}

for _, event := range events.Items {
	fmt.Printf("Event %s: %s at %s\n", event.EventID, event.EventName, event.Timestamp)
}

Fehlerbehandlung

Wenn die API einen nicht erfolgreichen Statuscode zurückgibt, gibt das SDK einen Fehler des Typs *dodopayments.Error zurück. Er stellt den StatusCode, den zugrunde liegenden *http.Request und *http.Response sowie das JSON des Fehler-Bodys bereit. Verwende das errors.As-Muster, um ihn zu untersuchen, und verzweige anhand von StatusCode, um bestimmte Fälle zu behandeln:

payment, err := client.Payments.New(ctx, dodopayments.PaymentNewParams{
	Billing: dodopayments.F(dodopayments.BillingAddressParam{
		Country: dodopayments.F(dodopayments.CountryCodeUs),
		City:    dodopayments.F("San Francisco"),
		State:   dodopayments.F("CA"),
		Street:  dodopayments.F("1 Market St"),
		Zipcode: dodopayments.F("94105"),
	}),
	Customer: dodopayments.F[dodopayments.CustomerRequestUnionParam](
		dodopayments.AttachExistingCustomerParam{CustomerID: dodopayments.F("cus_123")},
	),
	ProductCart: dodopayments.F([]dodopayments.OneTimeProductCartItemParam{{
		ProductID: dodopayments.F("pdt_456"),
		Quantity:  dodopayments.F(int64(1)),
	}}),
})
if err != nil {
	var apiErr *dodopayments.Error
	if errors.As(err, &apiErr) {
		fmt.Printf("Status Code: %d\n", apiErr.StatusCode)
		fmt.Println(string(apiErr.DumpResponse(true))) // Serialized HTTP response

		// Handle specific status codes
		switch apiErr.StatusCode {
		case 401:
			log.Println("Authentication failed")
		case 422:
			log.Println("Invalid request parameters")
		case 429:
			log.Println("Rate limit exceeded")
		default:
			log.Printf("API error: %s", apiErr.Error())
		}
	} else {
		log.Fatal(err)
	}
}

Middleware

Benutzerdefinierte Middleware für Logging oder Metriken hinzufügen:

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	log.Printf("Request: %s %s\n", req.Method, req.URL)

	// Forward the request to the next handler
	res, err = next(req)

	// After the request
	end := time.Now()
	log.Printf("Response: %d in %v\n", res.StatusCode, end.Sub(start))

	return res, err
}

client := dodopayments.NewClient(
	option.WithMiddleware(Logger),
)

Concurrency

Der Client kann sicher nebenläufig verwendet werden:

package main

import (
	"context"
	"sync"
	"log"

	"github.com/dodopayments/dodopayments-go"
)

func main() {
	client := dodopayments.NewClient()
	
	var wg sync.WaitGroup
	for i := 0; i < 10; i++ {
		wg.Add(1)
		go func(idx int) {
			defer wg.Done()
			
			payment, err := client.Payments.New(context.Background(), dodopayments.PaymentNewParams{
				Billing: dodopayments.F(dodopayments.BillingAddressParam{
					Country: dodopayments.F(dodopayments.CountryCodeUs),
					City:    dodopayments.F("San Francisco"),
					State:   dodopayments.F("CA"),
					Street:  dodopayments.F("1 Market St"),
					Zipcode: dodopayments.F("94105"),
				}),
				Customer: dodopayments.F[dodopayments.CustomerRequestUnionParam](
					dodopayments.AttachExistingCustomerParam{CustomerID: dodopayments.F("cus_123")},
				),
				ProductCart: dodopayments.F([]dodopayments.OneTimeProductCartItemParam{{
					ProductID: dodopayments.F("pdt_456"),
					Quantity:  dodopayments.F(int64(1)),
				}}),
			})
			if err != nil {
				log.Printf("Failed to create payment %d: %v", idx, err)
				return
			}
			
			log.Printf("Created payment %d: %s", idx, payment.PaymentID)
		}(i)
	}
	
	wg.Wait()
}

Ressourcen

GitHub Repository

Quellcode anzeigen und beitragen

API Reference

Vollständige API-Dokumentation

Discord Community

Hilfe erhalten und mit Entwicklern verbinden

Report Issues

Fehler melden oder Funktionen anfordern

Support

Benötigst du Hilfe mit dem Go SDK?

Discord: Tritt unserem Community-Server bei, um Support in Echtzeit zu erhalten
E-Mail: Kontaktiere uns unter support@dodopayments.com
GitHub: Erstelle ein Issue im Repository

Mitwirken

Wir freuen uns über Beiträge! Lies die Richtlinien zum Mitwirken, um loszulegen.

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Go

Installation

Schnellstart

Kernfunktionen

Context Support

Strong Typing

Middleware

Goroutine Safe

Konfiguration

Kontext und Zeitüberschreitungen

Wiederholungs-Konfiguration

Häufige Operationen

Erstellen einer Checkout-Sitzung

Kunden verwalten

Abonnements verwalten

Nutzungsbasierte Abrechnung

Nutzungsereignisse erfassen

Nutzungsereignisse auflisten

Fehlerbehandlung

Middleware

Concurrency

Ressourcen

GitHub Repository

API Reference

Discord Community

Report Issues

Support

Mitwirken

​Installation

​Schnellstart

​Kernfunktionen

Context Support

Strong Typing

Middleware

Goroutine Safe

​Konfiguration

​Kontext und Zeitüberschreitungen

​Wiederholungs-Konfiguration

​Häufige Operationen

​Erstellen einer Checkout-Sitzung

​Kunden verwalten

​Abonnements verwalten

​Nutzungsbasierte Abrechnung

​Nutzungsereignisse erfassen

​Nutzungsereignisse auflisten

​Fehlerbehandlung

​Middleware

​Concurrency

​Ressourcen

GitHub Repository

API Reference

Discord Community

Report Issues

​Support

​Mitwirken

Installation

Schnellstart

Kernfunktionen

Konfiguration

Kontext und Zeitüberschreitungen

Wiederholungs-Konfiguration

Häufige Operationen

Erstellen einer Checkout-Sitzung

Kunden verwalten

Abonnements verwalten

Nutzungsbasierte Abrechnung

Nutzungsereignisse erfassen

Nutzungsereignisse auflisten

Fehlerbehandlung

Middleware

Concurrency

Ressourcen

Support

Mitwirken