Tracking-Domain
Verwalten Sie Ihre Tracking-Domains.
API-Endpunkt-Adressen
| Rechenzentrum | URL |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Türkei | https://emailapi-tr.engagelab.com |
Beim Einsatz der REST API stellen Sie bitte sicher, dass das gewählte Rechenzentrum zur entsprechenden Basis-URL passt.
POST /v1/tracking-domains
Abfragen
Tracking-Domains abfragen – API-Schnittstelle
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-domains
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(apiUser:apiKey) |
Beschreibung der Query-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| name | string | nein | Domain-Name |
| offset | int | nein | Offset-Position, [0-], Standardwert: 0 |
| limit | int | nein | Maximale Anzahl, [0-100], Standardwert: 100 |
Beispiel-Request
curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/tracking-domains?name=engagelab.com" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| domain_id | Domain-ID |
| name | Domain-Name |
| cname | Details zum CNAME-Record der Domain |
| ├─ verify | Gibt an, ob die Konfiguration erfolgreich ist (true oder false) |
| ├─ verify_message | Nachricht zur CNAME-Konfiguration oder null, falls korrekt |
| ├─ required_record | Zu konfigurierender CNAME-Record |
| └─ existed_record | Vom Nutzer eingerichteter CNAME-Record |
| cert | Details zum Zertifikat der Domain |
| ├─ verify | Gibt an, ob die Konfiguration erfolgreich ist (true oder false) |
| ├─ verify_message | Zertifikat wurde nicht hochgeladen, wird konfiguriert, ist aktiv oder ist abgelaufen |
| └─ expired_date | Ablaufdatum |
| create_time | Zeitpunkt der Domain-Erstellung |
| update_time | Zeitpunkt der letzten Änderung |
Beispiel für Rückgabewerte
Erfolgreiche Antwort
HTTP Status: 200
{
"result": [
{
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "Die Konfiguration war erfolgreich",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "Das Zertifikat ist aktiv",
"expired_date": "2025-12-02T07:59:59+0800"
}
},
{
"domain_id": 1000402,
"name": "track.myMail.com",
"create_time": "2025-04-18T13:05:57+0800",
"update_time": "2025-04-18T13:05:57+0800",
"cname": {
"verify": false,
"verify_message": "Der CNAME-Record ist nicht konfiguriert",
"required_record": "track01.engagelab.email",
"existed_record": ""
},
"cert": {
"verify": false,
"verify_message": "Das Zertifikat wurde nicht hochgeladen",
"expired_date": ""
}
}
],
"total": 2,
"count": 2
}
{
"result": [
{
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "Die Konfiguration war erfolgreich",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "Das Zertifikat ist aktiv",
"expired_date": "2025-12-02T07:59:59+0800"
}
},
{
"domain_id": 1000402,
"name": "track.myMail.com",
"create_time": "2025-04-18T13:05:57+0800",
"update_time": "2025-04-18T13:05:57+0800",
"cname": {
"verify": false,
"verify_message": "Der CNAME-Record ist nicht konfiguriert",
"required_record": "track01.engagelab.email",
"existed_record": ""
},
"cert": {
"verify": false,
"verify_message": "Das Zertifikat wurde nicht hochgeladen",
"expired_date": ""
}
}
],
"total": 2,
"count": 2
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerhafte Antwort
HTTP Status: 401
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
Diesen Codeblock im schwebenden Fenster anzeigen
Hinzufügen
Tracking-Domain hinzufügen
URL
https://email.api.engagelab.cc/v1/tracking-domains
https://email.api.engagelab.cc/v1/tracking-domains
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
POST
POST
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(apiUser:apiKey) |
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| name | string | ja | Domain-Name |
Wichtiger Hinweis:
Sie können bis zu 5 eigene Tracking-Domains hinzufügen. Der Domain-Name kann nach erfolgreicher Verifizierung nicht mehr geändert werden. Eine fehlerhafte Konfiguration kann dazu führen, dass Links in E-Mails nicht anklickbar sind, Tracking-Daten fehlerhaft sind usw.
Aufgrund von Updates in Chrome und anderen Browsern wird das Laden von HTTP-Ressourcen künftig blockiert. Dies kann dazu führen, dass Inhalte als unsicher eingestuft werden und Tracking-Daten fehlerhaft sind. Es wird dringend empfohlen, ein SSL-Zertifikat für die HTTPS-Konfiguration hochzuladen und HTTPS-Tracking zu aktivieren.
Beispiel-Request
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
"name":"track.leonww.asia"
}'
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
"name":"track.leonww.asia"
}'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| domain_id | Domain-ID |
| name | Domain-Name |
| cname | Details zum CNAME-Record der Domain |
| ├─ verify | Gibt an, ob die Konfiguration erfolgreich ist (true oder false) |
| ├─ verify_message | Nachricht zur CNAME-Konfiguration oder null, falls korrekt |
| ├─ required_record | Zu konfigurierender CNAME-Record |
| └─ existed_record | Vorhandener CNAME-Record |
| create_time | Zeitpunkt der Domain-Erstellung |
| update_time | Zeitpunkt der letzten Änderung |
Beispiel für Rückgabewerte
Erfolgreiche Antwort
HTTP Status: 200
{
"result":
{
"domain_id": 1000423,
"name": "track.leonww.asia",
"create_time": "2025-09-03T13:42:41+0800",
"update_time": "2025-09-03T13:42:41+0800",
"cname": {
"verify": false,
"verify_message": "Der CNAME-Record ist nicht konfiguriert",
"required_record": "track01.engagelab.email",
"existed_record": ""
}
}
}
{
"result":
{
"domain_id": 1000423,
"name": "track.leonww.asia",
"create_time": "2025-09-03T13:42:41+0800",
"update_time": "2025-09-03T13:42:41+0800",
"cname": {
"verify": false,
"verify_message": "Der CNAME-Record ist nicht konfiguriert",
"required_record": "track01.engagelab.email",
"existed_record": ""
}
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerhafte Antwort
HTTP Status: 400
{
"code": 31003,
"message": "Domain-Name-Formatfehler"
}
{
"code": 31003,
"message": "Domain-Name-Formatfehler"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Tracking-Domain bearbeiten
Tracking-Domains bearbeiten – API-Schnittstelle
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
PUT
PUT
Diesen Codeblock im schwebenden Fenster anzeigen
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(apiUser:apiKey) |
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| name | string | ja | Domain-Name. Muss dem Domain-Format entsprechen, darf nur alphanumerische Zeichen, Bindestriche (-) und Punkte (.) enthalten und zwischen 4 und 255 Zeichen lang sein (z. B. mail.test.best). |
Beispiel-Request
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/22332" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
"name":"aizl.net"
}'
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/22332" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
"name":"aizl.net"
}'
Diesen Codeblock im schwebenden Fenster anzeigen
Beispiel für Rückgabewerte
Erfolgreiche Antwort
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerhafte Antwort
HTTP Status: 400
{
"code": 31003,
"message": "Domain-Name-Formatfehler"
}
{
"code": 31003,
"message": "Domain-Name-Formatfehler"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Tracking-Domain verifizieren
Tracking-Domain verifizieren – API-Schnittstelle
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/verify
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Wichtiger Hinweis
Zeigt nur Tracking-Domains mit erfolgreicher Verifizierung an.
Beispiel-Request
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/verify" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| domain_id | Domain-ID |
| name | Domain-Name |
| cname | Details zum CNAME-Record der Domain |
| ├─ verify | Gibt an, ob die Konfiguration erfolgreich ist (true oder false) |
| ├─ verify_message | Nachricht zur CNAME-Konfiguration oder null, falls korrekt |
| ├─ required_record | Zu konfigurierender CNAME-Record |
| └─ existed_record | Vorhandener CNAME-Record |
| cert | Details zum Zertifikat der Domain |
| ├─ verify | Gibt an, ob die Konfiguration erfolgreich ist (true oder false) |
| ├─ verify_message | Zertifikat wurde nicht hochgeladen, wird konfiguriert, ist aktiv oder ist abgelaufen |
| └─ expired_date | Ablaufdatum |
| create_time | Zeitpunkt der Domain-Erstellung |
| update_time | Zeitpunkt der letzten Änderung |
Beispiel für Rückgabewerte
Erfolgreiche Antwort
HTTP Status: 200
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "Die Konfiguration war erfolgreich",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "Das Zertifikat ist aktiv",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cname": {
"verify": true,
"verify_message": "Die Konfiguration war erfolgreich",
"required_record": "track01.engagelab.email",
"existed_record": "track01.engagelab.email"
},
"cert": {
"verify": true,
"verify_message": "Das Zertifikat ist aktiv",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerhafte Antwort
HTTP Status: 401
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
Diesen Codeblock im schwebenden Fenster anzeigen
SSL-Zertifikat für Tracking-Domain hinzufügen
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
POST
POST
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| cert_content | string | ja | Inhalt des Zertifikats (PEM-codiert) |
| cert_key | string | ja | Privater Schlüssel des Zertifikats (PEM-codiert) |
Beispiel-Request
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--data '{
"cert_content":"...",
"cert_key":"..."
}'
curl -X POST "https://email.api.engagelab.cc/v1/tracking-domains/123/cert" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--data '{
"cert_content":"...",
"cert_key":"..."
}'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| domain_id | Domain-ID |
| name | Domain-Name |
| cert | Details zum Zertifikat der Domain |
| ├─ verify | Gibt an, ob die Konfiguration erfolgreich ist (true oder false) |
| ├─ verify_message | Zertifikat wurde nicht hochgeladen, wird konfiguriert, ist aktiv oder ist abgelaufen |
| └─ expired_date | Ablaufdatum |
| create_time | Zeitpunkt der Domain-Erstellung |
| update_time | Zeitpunkt der letzten Änderung |
Beispiel für Rückgabewerte
Erfolgreiche Antwort
HTTP Status: 200
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cert": {
"verify": false,
"verify_message": "Das Zertifikat wird konfiguriert",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
{
"result": {
"domain_id": 1000403,
"name": "track.leonww.asia",
"create_time": "2025-04-18T13:27:38+0800",
"update_time": "2025-09-04T12:32:56+0800",
"cert": {
"verify": false,
"verify_message": "Das Zertifikat wird konfiguriert",
"expired_date": "2025-12-02T07:59:59+0800"
}
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerhafte Antwort
HTTP Status: 401
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
Diesen Codeblock im schwebenden Fenster anzeigen
SSL-Zertifikat aktualisieren
SSL-Zertifikat für Tracking-Domain aktualisieren
URL
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
PUT
PUT
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| cert_content | string | ja | Inhalt des Zertifikats (PEM-codiert) |
| cert_key | string | ja | Privater Schlüssel des Zertifikats (PEM-codiert) |
Beispiel-Request
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X PUT "https://email.api.engagelab.cc/v1/tracking-domains/{domain_id}/cert" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Erfolgreiche Antwort
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerhafte Antwort
HTTP Status: 401
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
Diesen Codeblock im schwebenden Fenster anzeigen
Tracking-Domain und Tracking-Einstellungen für API_USER aktualisieren
URL
https://email.api.engagelab.cc/v1/api_users/{api_user}
https://email.api.engagelab.cc/v1/api_users/{api_user}
Diesen Codeblock im schwebenden Fenster anzeigen
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
PUT
PUT
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| domain_name | string | nein | Die mit dem API_USER verknüpfte Domain |
| track_domain_name | string | nein | Die mit dem API_USER verknüpfte Tracking-Domain |
| open_tracking | boolean | nein | Öffnungs-Tracking aktivieren. Werte: false (deaktivieren), true (aktivieren). Standard: false. |
| click_tracking | boolean | nein | Klick-Tracking aktivieren. Werte: false (deaktivieren), true (aktivieren). Standard: false. |
| unsubscribe_tracking | boolean | nein | Abmelde-Tracking aktivieren. Werte: false (deaktivieren), true (aktivieren). Standard: true. |
Beispiel-Request
curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X PUT "https://email.api.engagelab.cc/v1/api_users/{api_user}" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Erfolgreiche Antwort
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerhafte Antwort
HTTP Status: 401
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
{
"code": 30000,
"message": "Nicht autorisiert (Unauthorized)."
}
Diesen Codeblock im schwebenden Fenster anzeigen
