Zugang

Die API authentifiziert per HTTP Basic mit Benutzername und Passwort Ihres Kontos. Den Zugang schalten Sie selbst ein und können ihn auf bestimmte IP-Adressen begrenzen.

Sie brauchen ein Konto, um die API zu nutzen.

Beispiel

Ein Aufruf mit curl sieht so aus:

curl -u BENUTZER:PASSWORT \
  https://trash.de/api/mailboxes

Überblick

Die Endpunkte der API mit Methode, Pfad und Zweck
Methode Pfad Zweck
GET /api/account Konto, Guthaben und die Kosten der Vorgänge
GET /api/transactions Buchungen, seitenweise
GET /api/pricing Guthabenpakete und Preise je Domainendung
GET /api/domains Zugeordnete Domains, gemeinsame wie eigene
POST /api/domains Weitere gemeinsame Domain zuordnen
POST /api/domains/register Eigene Domain registrieren
POST /api/domains/{id}/renew Eigene Domain um ein Jahr verlängern
GET /api/mailboxes Mailboxen des Kontos
POST /api/mailboxes Mailbox anlegen
GET /api/mailboxes/{id} Einzelne Mailbox
GET /api/mailboxes/{id}/messages Nachrichten im Posteingang
GET /api/mailboxes/{id}/messages/{uid} Einzelne Nachricht im Klartext

Mengenbegrenzung

Pro Konto sind 60 Anfragen je Minute möglich. Wird die Grenze erreicht, antwortet die Schnittstelle mit dem Status 429 und nennt in der Kopfzeile Retry-After die Wartezeit in Sekunden. Fehlgeschlagene Anmeldungen zählen gesondert und führen schneller zu einer Sperre.

Vollständige Dokumentation

Alle Endpunkte mit Parametern und Antwortschemata stehen als OpenAPI-Beschreibung bereit. Dort lassen sich Aufrufe auch direkt ausprobieren.

Was die API nicht kann

Passwort ändern, die Zwei-Faktor-Anmeldung verwalten, den API-Zugang selbst umschalten und Guthaben aufladen bleiben der Website vorbehalten. Die ersten drei sichern das Konto selbst ab, das Aufladen läuft über unseren Zahlungsdienstleister.