API Reference

Vollständige REST API Dokumentation für Entwickler.

REST API v1JSONRate Limited
Base URL:
https://www.mailaura.io/api/v1

Interaktive API-Dokumentation

Teste alle Endpunkte direkt im Browser mit Swagger UI

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://www.mailaura.io/api/v1/campaigns" \
  -H "X-API-Key: ml_live_abc123xyz789"

API-Schlüssel Berechtigungen

  • readNur-Lese-Zugriff auf Ressourcen
  • writeErstellen, Aktualisieren und Löschen von Ressourcen
  • sendKampagnen versenden

Beispiele

Abonnenten hinzufügen
Füge einen neuen Abonnenten mit Tags und benutzerdefinierten Feldern hinzu.
curl -X POST "https://www.mailaura.io/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"]
  }'
Transaktionale E-Mail senden
Sende eine E-Mail über die Transactional API (Passwort-Reset, Bestellbestätigung, etc.)
curl -X POST "https://www.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>Order confirmed.</p>",
    "priority": "high"
  }'

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.

Free

100 / h

Starter

500 / h

Pro

2,000 / h

Business

10,000 / h

X-RateLimit-Limit: 1000

X-RateLimit-Remaining: 999

X-RateLimit-Reset: 1699999999

Endpunkte

Die vollständige Endpoint-Dokumentation mit Parametern, Request/Response-Beispielen und Try-It-Out findest du in der interaktiven Swagger UI.

Campaigns

GET, POST, PUT, DELETE

REST

Lists

GET, POST, PUT, DELETE

REST

Subscribers

GET, POST, PUT, DELETE

REST

Templates

GET, POST, PUT, DELETE

REST

Webhooks

GET, POST

REST

Transactional Emails

POST

REST

Weiterführende Dokumentation