OpenAPI und andere Sprachen

Die gesamte API wird durch ein OpenAPI-3.1-Dokument beschrieben. Es speist die API-Referenz auf dieser Website und kann Clients für Sprachen ohne offizielles SDK generieren.

• Spezifikation: https://api.spacepost.dev/openapi.json
• Quelldatei im Repository: openapi/openapi.yaml

Einen Client generieren

Setze die Basis-URL auf https://api.spacepost.dev und konfiguriere die Bearer-Authentifizierung mit deinem sp_live_-Schlüssel.

TypeScript

Typen und ein Fetch-Client mit openapi-typescript und openapi-fetch:

npx openapi-typescript https://api.spacepost.dev/openapi.json -o spacepost.d.ts
npm install openapi-fetch

import createClient from "openapi-fetch";
import type { paths } from "./spacepost";

const client = createClient<paths>({
  baseUrl: "https://api.spacepost.dev",
  headers: { Authorization: `Bearer ${process.env.SPACEPOST_API_KEY}` },
});

const { data, error } = await client.POST("/emails", {
  body: { from: "Acme <hello@acme.com>", to: ["user@example.com"], subject: "Hi", html: "<p>Hi</p>" },
});

Python

pipx install openapi-python-client
openapi-python-client generate --url https://api.spacepost.dev/openapi.json

Go

go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@latest
curl -s https://api.spacepost.dev/openapi.json -o openapi.json
oapi-codegen -package spacepost -generate types,client openapi.json > spacepost.gen.go

Jede Sprache

Nutze den OpenAPI Generator:

npx @openapitools/openapi-generator-cli generate \
  -i https://api.spacepost.dev/openapi.json \
  -g ruby -o ./spacepost-ruby

Generatoren gibt es für PHP, Ruby, Java, Kotlin, Swift, C#, Rust und Dutzende weitere.

Tipp

Generierte Clients wissen nicht, dass Fehler eine gemeinsame Form haben, und kennen Idempotency-Key nicht. Füge diesen Header dort, wo du ihn brauchst, zu den Standard-Headern deines Clients oder den Headern pro Anfrage hinzu und parse Fehler als { statusCode, name, message }.

Postman und API-Tools

Importiere die URL der Spezifikation in Postman, Insomnia, Bruno oder Hoppscotch. Lege eine Collection-Variable für das Bearer-Token an.

Die Resend SDKs verwenden

Da SpacePost mit Resend kompatibel ist, funktionieren offizielle Resend SDKs in anderen Sprachen oft, wenn du ihre Basis-URL überschreibst. Siehe Migration von Resend.

API-ReferenzJeder Endpoint mit Schemas für Anfrage und Antwort.