Domain

Um E-Mails über EngageLab zu versenden, müssen Sie zunächst Ihre E-Mail-Domain konfigurieren. Die EngageLab Domain API bietet Ihnen die Möglichkeit, Domains effizient abzufragen, hinzuzufügen, zu ändern und zu verifizieren. In dieser Anleitung erfahren Sie, wie Sie die Domainverwaltung professionell und sicher umsetzen.

Aufrufadressen

Wählen Sie das passende Rechenzentrum und die entsprechende Basis-URL für Ihre REST-API-Aufrufe:

Rechenzentrum	URL
Singapur	https://email.api.engagelab.cc
Türkei	https://emailapi-tr.engagelab.com

Hinweis: Stellen Sie sicher, dass das gewählte Rechenzentrum zur verwendeten Basis-URL passt.

Domains abfragen (Batch-Abfrage)

Über diese Schnittstelle können Sie mehrere Domains gleichzeitig abfragen.

URL

https://email.api.engagelab.cc/v1/domains

              
              https://email.api.engagelab.cc/v1/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)

Query-Parameter

Parameter	Typ	Erforderlich	Beschreibung
names	string	nein	Domainname. Mit `;` trennen
type	int	nein	Domain-Typ: 0 (Testdomain), 1 (normale Domain)

Beispiel-Request

curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com;xjm.cc" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/domains?name=engagelab.com;xjm.cc" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Parameter	Beschreibung
domain_id	Domain-ID
name	Domainname
type	Domain-Typ
spf	SPF-Konfiguration
domain	Host-Record von SPF
value	Konfigurationswert von SPF
verify	Ob die Konfiguration erfolgreich ist (true oder false)
dkim	DKIM-Konfiguration
domain	Host-Record von DKIM
value	Konfigurationswert von DKIM
verify	Ob die Konfiguration erfolgreich ist (true oder false)
mx	MX-Konfiguration
domain	Host-Record von MX
value	Konfigurationswert von MX
verify	Ob die Konfiguration erfolgreich ist (true oder false)
dmarc	Host-Record von DMARC
domain	Host-Record von DMARC
value	Konfigurationswert von DMARC
verify	Ob die Konfiguration erfolgreich ist (true oder false)
create_time	Zeitpunkt der Domain-Erstellung
update_time	Zeitpunkt der Domain-Änderung

Beispiel für Rückgabewerte

HTTP Status: 200

{ "result": [ { "domain_id": 147799, "name": "22edc.com", "type": 1, "spf": { "domain": "22edc.com", "value": "v=spf1 include:spf.email.engagelab.com -all", "verify": false }, "dkim": { "domain": "mail._domainkey.22edc.com", "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB", "verify": false }, "mx": { "domain": "22edc.com", "value": "mx1.engagelab.com", "verify": false }, "dmarc": { "domain": "_dmarc.22edc.com", "value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com", "verify": false }, "create_time": "2022-11-12T15:38:14+0800", "update_time": "2022-12-15T10:52:05+0800" } ], "count": 1 }

              
              {
    "result": [
        {
            "domain_id": 147799,
            "name": "22edc.com",
            "type": 1,
            "spf": {
                "domain": "22edc.com",
                "value": "v=spf1 include:spf.email.engagelab.com -all",
                "verify": false
            },
            "dkim": {
                "domain": "mail._domainkey.22edc.com",
                "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
                "verify": false
            },
            "mx": {
                "domain": "22edc.com",
                "value": "mx1.engagelab.com",
                "verify": false
            },
            "dmarc": {
                "domain": "_dmarc.22edc.com",
                "value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
                "verify": false
            },
            "create_time": "2022-11-12T15:38:14+0800",
            "update_time": "2022-12-15T10:52:05+0800"
        }
    ],
    "count": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP Status: 401

{ "code": 30000, "message": "Authentication failed." }

              
              { 
    "code": 30000,
    "message": "Authentication failed."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Domain hinzufügen

Fügen Sie über diese Schnittstelle eine neue Domain hinzu.

URL

https://email.api.engagelab.cc/v1/domains

              
              https://email.api.engagelab.cc/v1/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)

Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
name	string	ja	Domainname. Muss dem Domain-Format entsprechen und darf nur [0-9a-zA-Z -.], 4~255 Zeichen enthalten, z. B. mail.test.best.

Hinweis:
Jede:r Nutzer:in kann maximal 5 Domains hinzufügen.

Beispiel-Request

curl -X POST "https://email.api.engagelab.cc/v1/domains" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \ --header "Content-Type: application/json" \ --data '{ "name":"m1314520.com" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/domains" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
  "name":"m1314520.com"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Die API gibt die Informationen zur berechtigten Domain zurück.

Parameter	Beschreibung
domain_id	Domain-ID
name	Domainname
type	Domain-Typ
spf	SPF-Konfiguration
domain	Host-Record von SPF
value	Konfigurationswert von SPF
verify	Ob die Konfiguration erfolgreich ist (true oder false)
dkim	DKIM-Konfiguration
domain	Host-Record von DKIM
value	Konfigurationswert von DKIM
verify	Ob die Konfiguration erfolgreich ist (true oder false)
mx	MX-Konfiguration
domain	Host-Record von MX
value	Konfigurationswert von MX
verify	Ob die Konfiguration erfolgreich ist (true oder false)
dmarc	Host-Record von DMARC
domain	Host-Record von DMARC
value	Konfigurationswert von DMARC
verify	Ob die Konfiguration erfolgreich ist (true oder false)
create_time	Zeitpunkt der Domain-Erstellung
update_time	Zeitpunkt der Domain-Änderung

Beispiel für Rückgabewerte

HTTP Status: 200

{ "result": { "domain_id": 147799, "name": "22edc.com", "type": 1, "spf": { "domain": "22edc.com", "value": "v=spf1 include:spf.email.engagelab.com -all", "verify": false }, "dkim": { "domain": "mail._domainkey.22edc.com", "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB", "verify": false }, "mx": { "domain": "22edc.com", "value": "mx1.engagelab.com", "verify": false }, "dmarc": { "domain": "_dmarc.22edc.com", "value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com", "verify": false }, "create_time": "2022-11-12T15:38:14+0800", "update_time": "2022-12-15T10:52:05+0800" } }

              
              {
    "result": {
        "domain_id": 147799,
        "name": "22edc.com",
        "type": 1,
        "spf": {
            "domain": "22edc.com",
            "value": "v=spf1 include:spf.email.engagelab.com -all",
            "verify": false
        },
        "dkim": {
            "domain": "mail._domainkey.22edc.com",
            "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
            "verify": false
        },
        "mx": {
            "domain": "22edc.com",
            "value": "mx1.engagelab.com",
            "verify": false
        },
        "dmarc": {
            "domain": "_dmarc.22edc.com",
            "value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
            "verify": false
        },
        "create_time": "2022-11-12T15:38:14+0800",
        "update_time": "2022-12-15T10:52:05+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP Status: 400

{ "code": 31003, "message": "Domain name format error" }

              
              {
    "code": 31003,
    "message": "Domain name format error"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Domain ändern

Über diese Schnittstelle können Sie eine bestehende Domain anpassen.

URL

https://email.api.engagelab.cc/v1/domains/{domain_id}

              
              https://email.api.engagelab.cc/v1/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)

Body-Parameter

Parameter	Typ	Erforderlich	Beschreibung
name	string	ja	Domainname. Muss dem Domain-Format entsprechen und darf nur [0-9a-zA-Z -.], 4~255 Zeichen enthalten, z. B. mail.test.best.

Hinweis:
Domains mit verifizierter Konfiguration können nicht geändert werden.

Beispiel-Request

curl -X PUT "https://email.api.engagelab.cc/v1/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/domains/22332" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
  "name":"aizl.net"
}'

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Die API gibt die aktuellen Informationen zur berechtigten Domain zurück.

Parameter	Beschreibung
domain_id	Domain-ID
name	Domainname
type	Domain-Typ
spf	SPF-Konfiguration
domain	Host-Record von SPF
value	Konfigurationswert von SPF
verify	Ob die Konfiguration erfolgreich ist (true oder false)
dkim	DKIM-Konfiguration
domain	Host-Record von DKIM
value	Konfigurationswert von DKIM
verify	Ob die Konfiguration erfolgreich ist (true oder false)
mx	MX-Konfiguration
domain	Host-Record von MX
value	Konfigurationswert von MX
verify	Ob die Konfiguration erfolgreich ist (true oder false)
dmarc	Host-Record von DMARC
domain	Host-Record von DMARC
value	Konfigurationswert von DMARC
verify	Ob die Konfiguration erfolgreich ist (true oder false)
create_time	Zeitpunkt der Domain-Erstellung
update_time	Zeitpunkt der Domain-Änderung

Beispiel für Rückgabewerte

HTTP Status: 200

              
              {
    "result": {
        "domain_id": 147799,
        "name": "22edc.com",
        "type": 1,
        "spf": {
            "domain": "22edc.com",
            "value": "v=spf1 include:spf.email.engagelab.com -all",
            "verify": false
        },
        "dkim": {
            "domain": "mail._domainkey.22edc.com",
            "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCmiE1poIZgcYRhTCtmgC20ASZVABbMxZWHuPG1W4JBmmkaTOjjzCUSjpBvWxgHOtzPQcQ9F8PY9iL9b3WGajwtEaEiJjk6z6ezeZzDOyYUnk79B6lrcGmNOVKaJOyh5qSOr3N0t36BbO9g37+PqYhisZH3kORLCqMrTcHuUFsJ7QIDAQAB",
            "verify": false
        },
        "mx": {
            "domain": "22edc.com",
            "value": "mx1.engagelab.com",
            "verify": false
        },
        "dmarc": {
            "domain": "_dmarc.22edc.com",
            "value": "v=DMARC1;p=reject;ruf=mailto:dmarc@22edc.com;rua=mailto:dmarc_report@22edc.com",
            "verify": false
        },
        "create_time": "2022-11-12T15:38:14+0800",
        "update_time": "2022-11-22T13:39:05+0800"
    }
}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP Status: 400

{ "code": 31003, "message": "Domain name format error" }

              
              {
    "code": 31003,
    "message": "Domain name format error"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Domain verifizieren

Über diese Schnittstelle können Sie Domains verifizieren und den aktuellen Konfigurationsstatus abfragen.

URL

https://email.api.engagelab.cc/v1/domains/check

              
              https://email.api.engagelab.cc/v1/domains/check

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP-Request-Methode

GET

GET

Diesen Codeblock im schwebenden Fenster anzeigen

Parameter

Parameter	Typ	Erforderlich	Beschreibung
name	string	nein	Domainname. Mehrere mit `;` trennen.

Hinweis:
Es werden nur Domains mit verifizierter Konfiguration zurückgegeben.

Beispiel-Request

curl -X POST "https://email.api.engagelab.cc/v1/domains/check?name=aizl.net;m1214520.com" \ --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X POST "https://email.api.engagelab.cc/v1/domains/check?name=aizl.net;m1214520.com" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Diesen Codeblock im schwebenden Fenster anzeigen

Beschreibung der Rückgabewerte

Die API gibt die Informationen zur berechtigten Domain zurück.

Parameter	Beschreibung
name	Domainname
type	Domain-Typ
config	Konfigurationsobjekt
dkim	true oder false
mx	true oder false
spf	true oder false
dmarc	true oder false
status	0: nicht verifiziert, 1: nutzbar, 2: verifiziert

Beispiel für Rückgabewerte

HTTP Status: 200

{ "result": [ { "name": "abc.com", "type": 1, "config": { "dkim": false, "mx": false, "spf": false, "dmarc": false }, "status": 2 } ] }

              
              {
    "result": [
        {
            "name": "abc.com",
            "type": 1,
            "config": {
                "dkim": false,
                "mx": false,
                "spf": false,
                "dmarc": false
            },
            "status": 2
        }
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

HTTP Status: 401

{ "code": 30000, "message": "Authentication failed." }

              
              {
    "code": 30000,
    "message": "Authentication failed."
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fazit

Mit der EngageLab Domain API verwalten Sie Ihre E-Mail-Domains zentral, sicher und effizient. Nutzen Sie die API, um Domains abzufragen, hinzuzufügen, zu ändern und zu verifizieren – und stellen Sie so einen reibungslosen E-Mail-Versand über EngageLab sicher.

Jetzt loslegen:

Domainverwaltung mit der EngageLab API

Aufrufadressen

Domains abfragen (Batch-Abfrage)

Domain hinzufügen

Domain ändern

Domain verifizieren

Fazit