EUID abfragen

Mit dieser API können Sie die EUID eines bestehenden Benutzers anhand eines im Projekt konfigurierten Benutzeridentifikators abfragen. Die API liest ausschließlich vorhandene Benutzerdaten und erstellt bei einem fehlenden Treffer keinen Benutzer und keine neue EUID. Für diese API gilt ein Ratenlimit von 1.000 Anfragen pro Minute und Projekt; bei Überschreitung wird HTTP 429 mit Fehlercode 55110 zurückgegeben.

API-Endpunkt

POST /v1/user/euid

Authentifizierung

Die EngageLab REST API verwendet HTTP Basic Authentication:

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Der Wert wird als base64(api_key:api_secret) erzeugt.

Anfragebeispiel

{ "identity_name": "user_id", "identity_values": ["user-1", "user-2"] }
              
              {
    "identity_name": "user_id",
    "identity_values": ["user-1", "user-2"]
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Feld Typ Erforderlich Beschreibung
identity_name String Ja Name eines im Projekt konfigurierten Benutzeridentifikators.
identity_values Array Ja Identifikatorwerte; 1 bis 100 Werte, je höchstens 256 Zeichen.

Antwortparameter

Feld Typ Beschreibung
code Int 0 bedeutet Erfolg, auch wenn Werte nicht gefunden werden.
message String Beschreibung des Ergebnisses.
data Array Ergebnisse in der Reihenfolge der Anfrage.
identity_value String Angefragter Identifikatorwert.
euid Long Vorhandene EUID oder null, wenn kein Benutzer gefunden wird.
error_code Int 0 für eine erfolgreiche Abfrage; ein fehlender Treffer liefert ebenfalls 0.

Beispielantwort

{ "code": 0, "message": "success", "data": [ {"identity_value": "user-1", "euid": 10362473, "error_code": 0}, {"identity_value": "user-not-found", "euid": null, "error_code": 0} ] }
              
              {
    "code": 0,
    "message": "success",
    "data": [
        {"identity_value": "user-1", "euid": 10362473, "error_code": 0},
        {"identity_value": "user-not-found", "euid": null, "error_code": 0}
    ]
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Code Beschreibung
40050 Authentifizierung der Schnittstelle fehlgeschlagen.
55004 Geschäftsparameter sind ungültig.
55101 Die Anzahl der Identifikatoren überschreitet 100.
55105 Ein Identifikatorwert überschreitet 256 Zeichen.
55106 Der Identifikator ist im Projekt nicht konfiguriert.
55107 Identifikatorname oder -wert ist leer.
55110 Ratenlimit überschritten (maximal 1.000 Anfragen pro Minute und Projekt).
Icon Solid Transparent White Qiyu
Vertrieb kontaktieren