Voraussetzungen
Was du brauchst, bevor du E-Mails über den Tuix Email Service sendest.
Bevor du eine E-Mail sendest, brauchst du:
- Ein Tuix-Konto für den Zugang zum Dashboard.
- Eine Application ID und eine Template UUID aus dem Tuix Dashboard.
- Einen API Key aus dem Tuix Dashboard. Siehe API Keys.
- Die Basis-URL der API (siehe unten).
Basis-URL
Setze API_BASE_URL auf den Host der gewünschten Umgebung:
| Umgebung | Basis-URL |
|---|---|
| Production | https://email-service.tuix.ch |
| Staging | https://staging-email-service.tuix.ch |
IDs finden
Du brauchst zwei IDs aus dem Dashboard: eine Application ID und eine Template UUID.
Application ID
Die Application ID identifiziert deine Anwendung und ist Teil des Sende-Pfads
(/api/applications/{applicationId}/emails/send).
Öffne im Dashboard den Bereich Applications: In der Spalte Application ID steht die ID, mit einem Kopier-Symbol daneben.
Template UUID
Die Template UUID identifiziert die zu sendende Vorlage. Öffne die Vorlagen einer Anwendung: In der Spalte Template ID steht die UUID, mit einem Kopier-Symbol daneben.
Authentifizierung
Die Authentifizierung erfolgt über einen API Key, der im x-api-key-Header
gesendet wird:
Ein privater API Key gehört nur auf den Server, gib ihn niemals an den Browser oder in Client-Bundles weiter. Nur ein als öffentlich erstellter Key darf im Frontend verwendet werden. Siehe API Keys.