Das seppmail.cloud-Portal basiert auf einer REST API, die auch von Partnern und Kunden genutzt werden kann, um Funktionen direkt in ihre eigenen Systeme zu integrieren und Aufgaben zu automatisieren, die über die Möglichkeiten der Browserschnittstelle hinausgehen. Das Swagger UI für das seppmail.cloud Backend (namens «Hera») ist verfügbar unter https://api.seppmail.com/?urls.primaryName=SEPPmail+Hera+0.1.0.
Abschnitte auf dieser Seite:
- REST API verwenden
- REST API Rate Limits (Ratenbegrenzungen)
- SEPPmail Secure E-Mail Gateway und seppmail.cloud API
REST API verwenden
Erstellen Sie im seppmail.cloud-Portal einen technischen Admin-Benutzer mit der/den entsprechenden Rolle(n).
Mit diesem Benutzer...
- kann die API mit der oben erwähnten Swagger UI getestet werden
- kann sich ein Skript anmelden und auf bestimmte Funktionen zugreifen
Bitte stellen Sie sicher, dass die Anmeldedaten dieses technischen Benutzers angemessen geschützt sind (beispielsweise nicht direkt im Quellcode enthalten).
Ein kleines Beispielskript finden Sie hier: https://github.com/seppmail/SEPPmail.Cloud-Tools
REST API Rate Limits (Ratenbegrenzungen)
Manche API-Anfragen können unsere Systeme erheblich belasten und somit das Erlebnis für alle Nutzer beeinträchtigen. Wir haben automatische Rate Limis (Ratenbegrenzungen) eingeführt und behalten uns das Recht vor, Nutzerkonten oder IPs im Falle eines wiederholten oder erheblichen Missbrauchs zu sperren.
Aufrufer der API sollten Mechanismen für Wiederholungsversuche mit angemessenen Zeitvorgaben einsetzen oder über andere ausfallsichere Mechanismen verfügen, für den Fall, dass die Ratenbegrenzungschwelle erreicht wird.
Die aktuell gültige formale Definition der für die REST API geltenden Ratenbegrenzungen ist in der entsprechenden Dienstbeschreibung zu finden (verfügbar im Abschnitt Dokumente des Partner-Portals in seppmail.cloud).
SEPPmail Secure E-Mail Gateway und seppmail.cloud API
Die seppmail.cloud API ist für Partner und Kunden gedacht, die Dienste in der seppmail.cloud haben. Während das SEPPmail Secure E-Mail Gateway auch den Kern der seppmail.cloud-Infrastruktur bildet, sind diese Anwendungen für Partner und Kunden nicht zugänglich.