Obtain EUID

EUID ist der eindeutige Identifikator der EngageLab MA-Plattform. Sie können die folgende API nutzen, um die EUID anhand des Benutzeridentifikators abzurufen.

API-Endpunkt

POST /v1/user/register

Authentifizierung

Die EngageLab REST API verwendet HTTP Basic Authentication als Authentifizierungsmethode. Fügen Sie dem HTTP-Header das Feld „Authorization“ hinzu:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Diesen Codeblock im schwebenden Fenster anzeigen

Der base64_auth_string wird nach folgendem Schema generiert: base64(api_key:api_secret).

Der Header-Name ist „Authorization“ und der Wert ist das base64-kodierte „Benutzername:Passwort“-Paar (durch Doppelpunkt getrennt).
Für die MA API entspricht der Benutzername dem APIKey und das Passwort dem APISecret. Bitte konfigurieren Sie eine API-Datenquelle, um APIKey und APISecret zu erhalten.

Beispiel für eine Anfrage

Anfrage-Header

> POST /v1/user/register > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

              
              > POST /v1/user/register
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrage-Body

{ "identity_name": "user_id", "identity_values": [ "18012345678", "18012345678" ] }

              
              {
    "identity_name": "user_id",
    "identity_values": [
        "18012345678",
        "18012345678"
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Feld	Typ	Erforderlich	Beschreibung
identity_name	String	Ja	Name des Benutzeridentifikators, unterstützt Werte wie user_id, anonymous_id oder registration_id
identity_values	Liste	Ja	Werte der Benutzeridentifikatoren, unterstützt bis zu 100 Werte, jeder Wert max. 256 Zeichen

Rückgabeparameter

Feld	Typ	Erforderlich	Beschreibung
code	Int	Ja	Gibt an, ob der API-Aufruf erfolgreich war. 0 bedeutet Erfolg oder Teilerfolg, andere Werte Fehler
message	String	Ja	Ergebnisbeschreibung des API-Aufrufs, Erläuterung des Rückgabecodes
data	Array	Nein	Liste der EUIDs, die den zurückgegebenen Benutzeridentifikatoren entsprechen
identity_value	String	Ja	Wert des Benutzeridentifikators
euid	Long	Ja	Die eindeutige Benutzer-ID, die der EngageLab MA zugeordnet ist
error_code	Int	Ja	Gibt an, ob die EUID-Abfrage erfolgreich war. 0 steht für Erfolg, andere Werte für Fehler

Vollständig erfolgreich

{ "code": 0, "message": "success", "data": [ { "identity_value": "18012345678", "euid": 10362473, "error_code": 0 }, { "identity_value": "18012340000", "euid": 10362474, "error_code": 0 } ] }

              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "18012345678",
            "euid": 10362473,
            "error_code": 0
        },
        {
            "identity_value": "18012340000",
            "euid": 10362474,
            "error_code": 0
        }
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

Vollständig fehlgeschlagen

{ "code": 55101, "message": "Anzahl der Benutzeridentifikatoren überschritten" }

              
              {
    "code": 55101,
    "message": "Anzahl der Benutzeridentifikatoren überschritten"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Teilweise erfolgreich

{ "code": 0, "message": "success", "data": [ { "identity_value": "18012345678", "euid": null, "error_code": -1 }, { "identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000", "euid": null, "error_code": 55105 } ] }

              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "18012345678",
            "euid": null,
            "error_code": -1
        },
        {
            "identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
            "euid": null,
            "error_code": 55105
        }
    ]
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Code	Beschreibung	Detaillierte Erklärung
40050	Schnittstellen-Authentifizierung 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 überprüfen Sie, ob APIKey und APISecret korrekt sind.
50034	Projekt-ID existiert nicht.	Bitte überprüfen Sie, ob APIKey und APISecret korrekt sind und ob das Projekt gelöscht wurde.
50074	API-Datenquelle existiert nicht.	Bitte überprüfen Sie, ob APIKey und APISecret korrekt sind und ob die API-Datenquelle gelöscht wurde.
55004	Geschäftsdaten sind ungültig.	Bitte überprüfen Sie, ob die Felder der Anfrageparameter korrekt sind.
55101	Die Anzahl der Benutzeridentifikatoren überschreitet das Limit.	Überprüfen Sie, ob die Anzahl der Werte für die Benutzeridentifikation 100 überschreitet.
55102	Es gibt ungültige Benutzereigenschaftsnamen.	Überprüfen Sie, ob der Attributname den Namensanforderungen entspricht, nicht leer ist/keine reservierten Zeichen verwendet/nicht zu lang ist.
55103	Benutzerattributwerte dürfen nicht leer sein.	Überprüfen Sie, ob der Wert des Benutzerattributs im Anfrage-Body leer ist.
55105	Der Wert des Benutzeridentifikators darf 256 Zeichen nicht überschreiten.	Überprüfen Sie, ob der Wert der Benutzeridentifikation 256 Zeichen überschreitet.
55106	Der Name des Benutzeridentifikators ist nicht im unterstützten Bereich.	Überprüfen Sie, ob der Name der Benutzeridentifikation user_id, anonymous_id oder registration_id ist.
55107	Der Wert des Benutzeridentifikators ist leer.	Überprüfen Sie, ob der Wert der Benutzeridentifikation 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.