Set User Attributes
Aufrufadresse
POST /v1/user/property
Authentifizierungsverfahren
Die EngageLab REST API verwendet HTTP Basic Authentication als Verifizierungsmethode. Fügen Sie den Header „Authorization“ hinzu:
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
Diesen Codeblock im schwebenden Fenster anzeigen
Der base64_auth_string wird folgendermaßen generiert: base64(api_key:api_secret).
- Der Header-Name ist „Authorization“, der Wert ist das base64-codierte „username:password“-Paar (durch einen Doppelpunkt getrennt).
- Für die MA API entspricht der Benutzername dem APIKey und das Passwort dem APISecret. Bitte richten Sie eine API-Datenquelle ein, um APIKey und APISecret zu erhalten.
Beispiel für eine Anfrage
Anfrage-Header
> POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
> POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
Diesen Codeblock im schwebenden Fenster anzeigen
Anfrage-Body
{
"euid": 10362473,
"type": "set",
"properties": {
"user_number_once": 46.2, // Benutzerattributname und Attributwert
"user_string_once": "refef",
"user_datetime_once": "2023-12-12 00:56:23"
}
}
{
"euid": 10362473,
"type": "set",
"properties": {
"user_number_once": 46.2, // Benutzerattributname und Attributwert
"user_string_once": "refef",
"user_datetime_once": "2023-12-12 00:56:23"
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Anfrageparameter
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| euid | Long | Ja | Die eindeutige Benutzer-ID von EngageLab MA |
| type | String | Ja | Der Operationstyp zur Aktualisierung der Benutzereigenschaften |
| properties | JSON | Ja | Die Liste der Benutzereigenschaften, wobei der Schlüssel den Attributnamen und der Wert den Attributwert darstellt |
Rückgabeparameter
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| code | Int | Ja | Gibt an, ob der API-Aufruf erfolgreich war. 0 bedeutet vollständig oder teilweise erfolgreich, andere Werte stehen für einen Fehlercode |
| message | String | Ja | Ergebnisbeschreibung des API-Aufrufs, erklärt den Rückgabecode |
Erfolgsmeldung
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlerfall
{
"code": 55102,
"message": "Ungültige Benutzereigenschaften vorhanden"
}
{
"code": 55102,
"message": "Ungültige Benutzereigenschaften vorhanden"
}
Diesen Codeblock im schwebenden Fenster anzeigen
Fehlercodes
| Fehlercode | Beschreibung | Detaillierte Erklärung |
|---|---|---|
| 40050 | Authentifizierung der API fehlgeschlagen. | Überprüfen Sie, ob Projekt-ID und Projektschlüssel korrekt sind. |
| 40007 | EUID ist leer. | Bitte überprüfen Sie den Wert der EUID. |
| 50031 | Projekt-ID ist ungültig. | Bitte prüfen Sie, ob APIKey und APISecret korrekt sind. |
| 50034 | Projekt-ID existiert nicht. | Bitte prüfen Sie, ob APIKey und APISecret korrekt sind und ob das Projekt gelöscht wurde. |
| 50074 | API-Datenquelle existiert nicht. | Bitte prüfen Sie, ob APIKey und APISecret korrekt sind und ob die API-Datenquelle gelöscht wurde. |
| 55004 | Geschäftsdaten sind ungültig. | Bitte prüfen Sie, ob die Felder der Anfrageparameter korrekt sind. |
| 55101 | Die Anzahl der Benutzerkennungen überschreitet das Limit. | Prüfen Sie, ob die Anzahl der Werte für die Benutzerkennung 100 überschreitet. |
| 55102 | Es existieren ungültige Benutzereigenschaftsnamen. | Prüfen Sie, ob der Attributname den Namensanforderungen entspricht und ob er leer ist/Reservierte Zeichen verwendet/das Längenlimit überschreitet. |
| 55103 | Benutzerattributwerte dürfen nicht leer sein. | Bitte überprüfen Sie, ob der Wert des Benutzerattributs im Anfrage-Body leer ist. |
| 55105 | Der Wert der Benutzerkennung darf maximal 256 Zeichen umfassen. | Bitte überprüfen Sie, ob der Wert der Benutzerkennung 256 Zeichen überschreitet. |
| 55106 | Der Name der Benutzerkennung ist nicht im unterstützten Bereich. | Bitte überprüfen Sie, ob der Name der Benutzerkennung user_id, anonymous_id oder registration_id ist. |
| 55107 | Der Wert der Benutzerkennung ist leer. | Bitte überprüfen Sie, ob der Wert der Benutzerkennung im Anfrage-Body leer ist. |
| 55108 | Ungültige EUID. | Bitte überprüfen Sie den Wert der EUID. |
| -1 | Interner Serverfehler. | Bitte wenden Sie sich an den technischen Support von EngageLab. |
