Zum Hauptinhalt springen

Erste Schritte

Um mit der mail2many API zu starten, nutze den /whoami Endpoint. Wenn du eine Antwort mit Informationen zu deinem Account erhältst, funktioniert alles:

curl -X GET "https://YOUR_SERVER-api.mail2many.de/api/v1/whoami" \
  --user 'mail2many:YOUR_API_KEY' \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Request-Lifecycle​

So läuft ein API-Request von der Authentifizierung bis zur Response ab:

1. Authentifizierung
   │ Authorization: Basic bWFpbDJtYW55OllPVVJfQVBJX0tFWQ==
   │
2. Request senden
   │ POST /subscribers
   │ Body: {"email": "...", "firstname": "..."}
   │
3. Server-Verarbeitung
   │ ├─ Authentifizierung prüfen
   │ ├─ Rate Limit Check (600/min, 10 parallel)
   │ ├─ Request-Validierung
   │ └─ Datenverarbeitung
   │
4. Response
   └─ 201 Created + Subscriber-Objekt (JSON)

REST API Grundlagen​

Die mail2many API ist ressourcenorientiert und RESTful aufgebaut:

  • Ressourcen sind unter verschiedenen Endpoints verfügbar, z. B. channels, subscribers, subscriberGroups oder mailings
  • HTTP‑Methoden (GET, POST, PUT, DELETE) ermöglichen die Interaktion mit Ressourcen
  • Anfragen und Antworten verwenden das JSON‑Format
  • Die API unterstützt nur JSON — XML oder andere Formate werden nicht unterstützt

Request‑ und Response‑Header​

Setze in deinen Anfragen die folgenden Header:

Content-Type: application/json
Accept: application/json

Dies stellt sicher, dass die API deine Daten korrekt interpretiert.

Technische Limits​

Beachte die API‑Limits früh in deiner Integration:

  • 600 Requests pro Minute pro API-Key
  • maximal 10 parallele Requests pro API-Key

Details und Header findest du unter Rate Limiting.

OpenAPI Dokumentation​

Die verfügbaren Endpunkte sind in der OpenAPI Specification dokumentiert. Du findest die Endpoint-Dokumentation