Hi, wie können wir Ihnen helfen?

In diesem Artikel bringen wir Ihnen die Rest-API bei WTS-Mail näher.

Basis-URL

https://api.wts-mail.de/api

Health-Check

Endpoint: GET /api

Beschreibung: Überprüft, ob die API erreichbar ist und liefert Basisinformationen zur API-Version und Authentifizierung.

Antwort (Beispiel):

{
  "Authentication-Info": {
    "login_details": null,
    "needed": false,
    "needed_roles": null,
    "provided": true,
    "type": null
  },
  "Gateway-Info": {
    "request_id": "UUID",
    "response_time": null,
    "success": true,
    "timestamp": "2025-04-17T09:44:54+02:00",
    "version": "1.0"
  },
  "data": {
    "message": "Welcome to Mail API",
    "status": "Online"
  }
}

✅ Hinweis: Keine Authentifizierung erforderlich.

Login (API-Token erzeugen)

Endpoint: GET /api/login?username=EMAIL&password=PASSWORT

Beschreibung: Authentifiziert den Benutzer und liefert ein temporäres API-Token für nachfolgende Anfragen.

Antwort (Beispiel):

{
  "access_token": "XXXXXXXX-XXXXXXXX-XXXXXXXX",
  "message": "API-Token generated successfully"
}

⚠️ Sicherheit: Übergabe von Login-Daten nur über HTTPS!

E-Mail abrufen

Endpoint: GET /api/fetch/email/{UUID_DER_EMAIL}?WTS-API-Token={API-TOKEN}

Beschreibung: Ruft eine spezifische E-Mail anhand der ID ab. Benötigt gültigen API-Token.

Antwort (Beispiel):

{
  "attachments": [],
  "body": {
    "html": "<div>Guten Tag Herr Muster ...</div>",
    "plain_text": "Guten Tag Herr Muster, ..."
  },
  "from": {
    "email": "lukas.waerner@gmail.com",
    "name": "Lukas Wärner"
  },
  "subject": "Test",
  "timestamp": "Sat, 25 Jan 2025 17:03:09 +0100",
  "to": {
    "email": "lukas.waerner@wts-mail.de",
    "name": "Max Muster"
  },
  "server": {
    "auth_results": {
      "dkim": { "result": "UNKNOWN" },
      "dmarc": { "result": "UNKNOWN" },
      "spf": { "result": "UNKNOWN" }
    },
    "sent_from": "gmail.com",
    "signed_by": "gmail.com"
  }
}

📌 Hinweis: Body ist im HTML- und Plaintext-Format vorhanden. Anhänge als Array.

Zusammenfassung der Endpunkte

Empfehlung zur Integration