The seppmail.cloud portal is entirely built upon a REST API which may also be used by partners and customers to integrate functions directly into their own systems and automate tasks beyond the capabilities of the browser interface. The Swagger UI for the seppmail.cloud backend (named "Hera") is available at https://api.seppmail.com/?urls.primaryName=SEPPmail+Hera+0.1.0.
Sections on this page:
How to use the REST API
Within the seppmail.cloud portal, create a technical admin user with the appropriate role(s).
With this user...
- the API can be tested using the Swagger UI mentioned above
- a script can log in and access certain functions
Please ensure the credentials of this technical user are properly protected (for example not directly included in source code).
A small sample script can be found here: https://github.com/seppmail/SEPPmail.Cloud-Tools.
REST API Rate Limits
Some API requests can cause significant load on our systems and may thus affect the experience for all users. We have implemented automated rate limits and reserve the right to block user accounts or IPs in case of repeated or significant misuse.
Callers of the API should employ mechanisms to handle retries with appropriate timings, or have some other fail-safe mechanisms in place, in case rate limit thresholds are reached.
The current formal definition of the rate limits applied to the seppmail.cloud REST API can be found in the corresponding Service Description (available in the Documents section of the seppmail.cloud Partner Portal).
SEPPmail Secure E-Mail Gateway and seppmail.cloud API
The seppmail.cloud API is intended for partners and customers who have services in the seppmail.cloud. While the SEPPmail Secure E-Mail Gateway also forms the core of the seppmail.cloud infrastructure, these appliances are not accessible to partners and customers.
