API Reference

Vollständige REST API Dokumentation für Entwickler.

REST API v1JSONRate Limited
Base URL:https://api.mailaura.com/api/v1OpenAPI Spec

Interaktive API-Dokumentation

Teste alle Endpunkte direkt im Browser mit Swagger UI

Swagger UI öffnen

Authentifizierung

Alle API-Anfragen erfordern einen API-Schlüssel. Du kannst API-Schlüssel im Dashboard unter Einstellungen → API-Schlüssel erstellen.

curl -X GET "https://api.mailaura.com/api/v1/campaigns" \
  -H "X-API-Key: ml_live_abc123xyz789"

API-Schlüssel Berechtigungen

  • read - Nur-Lese-Zugriff auf Ressourcen
  • write - Erstellen, Aktualisieren und Löschen von Ressourcen
  • send - Kampagnen versenden

Endpunkte

Campaigns
Klicke auf einen Endpunkt, um Parameter und Details zu sehen.

Beispiele

Abonnenten hinzufügen
Füge einen neuen Abonnenten mit Tags und benutzerdefinierten Feldern hinzu.
curl -X POST "https://api.mailaura.com/api/v1/subscribers" \
  -H "X-API-Key: ml_live_abc123xyz789" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "listId": "clx456def",
    "firstName": "Jane",
    "lastName": "Smith",
    "tags": ["vip", "newsletter"]
  }'
NEW
Transaktionale E-Mail senden
Sende eine E-Mail über die Transactional API (Passwort-Reset, Bestellbestätigung, etc.)
curl -X POST "https://mailaura.io/api/v1/send" \
  -H "X-Mailaura-Key: ml_trans_live_abc123xyz789" \
  -H "X-Mailaura-Secret: your-secret-here" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "user@example.com",
    "from": "noreply@yourapp.com",
    "subject": "Your Order Confirmation",
    "html": "<h1>Thank you!</h1><p>Your order has been confirmed.</p>",
    "priority": "high",
    "tags": ["order", "confirmation"]
  }'

Hinweis: Transactional API-Keys verwenden das Präfix ml_trans_live_ oder ml_trans_test_ (Sandbox). Erstelle sie unter Dashboard → Einstellungen → Transactional E-Mails.

Rate Limiting

API-Anfragen sind je nach Tarif begrenzt. Rate-Limit-Header werden in allen Antworten mitgesendet.

X-RateLimit-Limit: 1000

X-RateLimit-Remaining: 999

X-RateLimit-Reset: 1699999999