REST Integration Guide
Integration with Team Trixie’s REST Proxy is relatively straightforward, though there are some details we need to pay attention to.
- You need to provide us the “tenant” name of the party to integrate. It can be either the team name or application name and will act as the SMTP username.
- You need to provide us the desired sender address, so we can ensure that the domain is authenticated (currently only
vaillant-group.com). Although our custom SMTP relay does not currently mandate a sender, it is important property to ensure reliability and delivery. We will enforce that property in the future. - You will receive API username and API Key.
- Consult the API Documentation on the usage of the API
- Afterward you can access the E-Mail Proxy API using:
QA:
Base URL: https://email-proxy-qa.dsp.vaillant-group.com/api
Prod:
Base URL: https://email-proxy.dsp.vaillant-group.com/api
- Mailpit UI can be accessed from https://mailpit.qa.dsp.vaillant-group.cloud/ (Internal) and https://mailpit-qa.dsp.vaillant-group.com/ (External).
Whitelist feature
We are currently providing you the option to have some recipient emails whitelisted on QA, so instead of the message going directly to Mailpit, we can send it to real inbox. If you need such feature for your testing purposes, then please create a ticket in DSP helpdesk and we will configure that for you.
Important
- It is now possible right to send out emails from QA to real inboxes - whitelisted emails only.