API_USER – API Dokumentation für EngageLab E-Mail-API
API_USER ist das Verifizierungskonto, das zum Versenden von E-Mails in EngageLab verwendet wird.
Sie können API_USER per API suchen oder hinzufügen.
Endpunkt-Adresse
| Rechenzentrum | URL |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Türkei | https://emailapi-tr.engagelab.com |
Beim Einsatz der REST API ist sicherzustellen, dass das gewählte Rechenzentrum zur entsprechenden Basis-URL passt.
POST /v1/api_users
Abfrage (Batch)
Über diese Schnittstelle können Sie Basisinformationen zu API_USER abrufen.
URL
https://email.api.engagelab.cc/v1/api_users
HTTP-Anfragemethode
GET
Request Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(apiUser:apiKey) |
Beschreibung der Abfrageparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| email_type | int | nein | E-Mail-Typ: 0 (Trigger), 1 (Batch) |
| api_user_type | int | nein | API_USER-Typ: 0 (Test), 1 (Allgemein) |
| domain_name | string | nein | Zugehöriger Domainname |
Beispiel für eine Anfrage
curl "https://email.api.engagelab.cc/v1/api_users" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Beschreibung der Rückgabewerte
| Feld | Beschreibung |
|---|---|
| api_user | API_USER |
| api_user_type | API_USER-Typ: 0 (Test), 1 (Allgemein) |
| email_type | API_USER E-Mail-Typ |
| domain_name | Zugehörige Domain von API_USER |
| click_tracking | Klick-Tracking aktiviert: false (deaktiviert), true (aktiviert) |
| open_tracking | Öffnungs-Tracking aktiviert: false (deaktiviert), true (aktiviert) |
| unsubscribe_tracking | Abmelde-Tracking aktiviert: false (deaktiviert), true (aktiviert) |
Beispiel für Rückgabewert
Erfolgreiche Antwort
HTTP Status: 200
{
"result": [
{
"api_user": "xjmfcbatch",
"api_user_type": 1,
"email_type": 1,
"domain_name": "sc.datavalidation.cn",
"click_tracking": false,
"open_tracking": false,
"unsubscribe_tracking": false
}
],
"count": 85
}
Fehlerantwort
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed."
}
Hinzufügen
API_USER und API_KEY sind Zugangsdaten zur Authentifizierung bei der Nutzung der EngageLab-API und unterstützen die Unterscheidung zwischen Trigger- und Batch-E-Mail-Typen.
Mit dieser API können Sie einen API_USER hinzufügen und erhalten den zugehörigen API_KEY.
Bitte beachten Sie: Bevor Sie diese API zum Hinzufügen eines API_USER verwenden, prüfen Sie bitte, ob Sie bereits einen API_USER und API_KEY erstellt haben. Falls nicht, müssen Sie sich zunächst im Web-Backend anmelden und diese anlegen.
URL
https://email.api.engagelab.cc/v1/api_users
Content-Type:
application/json; charset=utf-8
HTTP-Anfragemethode
POST
Request Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Beschreibung der Body-Parameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| api_user | string | ja | Name des API_USER |
| email_type | int | ja | E-Mail-Typ: 0 (Trigger), 1 (Batch) |
| domain_name | string | ja | Zugehöriger Domainname des API_USER |
| track_domain_name | string | nein | Zugehöriger Tracking-Name des API_USER |
| open_tracking | boolean | nein | Öffnungs-Tracking aktivieren: false (deaktiviert), true (aktiviert); standardmäßig deaktiviert |
| click_tracking | boolean | nein | Klick-Tracking aktivieren: false (deaktiviert), true (aktiviert); standardmäßig deaktiviert |
| unsubscribe_tracking | boolean | nein | Abmelde-Tracking aktivieren: false (deaktiviert), true (aktiviert); standardmäßig aktiviert |
Hinweise:
- Das Abmelde-Tracking wird für kostenlose Nutzer:innen vom System zwangsweise aktiviert.
Beispiel für eine Anfrage
curl -X POST "https://email.api.engagelab.cc/v1/api_users" \
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
"api_user":"batch_edm",
"email_type":1,
"domain_name":"aizl.net"
}'
Beschreibung der Rückgabewerte
| Feld | Beschreibung |
|---|---|
| api_user | Name des API_USER |
| api_key | API_KEY |
| api_user_type | Typ des API_USER |
| email_type | E-Mail-Typ des API_USER |
| domain_name | Zugehörige Domain des API_USER |
| click_tracking | Klick-Tracking aktiviert |
| open_tracking | Öffnungs-Tracking aktiviert |
| unsubscribe_tracking | Abmelde-Tracking aktiviert |
Beispiel für Rückgabewert
Erfolgreiche Antwort
HTTP Status: 200
{
"result": {
"api_user": "xjmfcbatch",
"api_user_type": 1,
"api_key": "2*****",
"email_type": 1,
"domain_name": "sc.datavalidation.cn",
"click_tracking": false,
"open_tracking": false,
"unsubscribe_tracking": true
}
}
Fehlerantwort
HTTP Status: 400
{
"code": 31110,
"message": "api_user darf nicht leer sein."
}
Tipp: Für weitere Informationen zur Authentifizierung und Verwaltung Ihrer Zugangsdaten besuchen Sie bitte die offizielle EngageLab API Dokumentation.
