Obtain EUID

EUID is the unique identifier of the EngageLab MA platform. You can use the following API to retrieve the EUID based on the user identifier.

Invocation Address

POST /v1/user/register

Invocation Verification

The EngageLab REST API uses HTTP Basic Authentication as the verification method. Add Authorization to the HTTP Header:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

This code block in the floating window

The base64_auth_string is generated using the following algorithm: base64(api_key:api_secret).

The header name is "Authorization", and the value is the base64-encoded "username:password" pair (separated by a colon).
For the MA API, the username corresponds to the APIKey, and the password corresponds to the APISecret. Please configure an API-type data source to obtain the APIKey and API Secret.

Request Example

Request Header

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

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

This code block in the floating window

Request Body

{ "identity_name":"user_id", // User identifier name "identity_values": [ "18012345678", // User identifier value "18012345678" ] }

              
              {
    "identity_name":"user_id", // User identifier name
    "identity_values": [
        "18012345678",    // User identifier value
        "18012345678"
        ]
}

This code block in the floating window

Request Parameters

Field	Type	Required	Description
identity_name	String	Yes	Name of the user identifier, supports values such as user_id, anonymous_id, or registration_id
identity_values	list	Yes	User identifier values, supports up to 100 values, with each value not exceeding 256 characters

Return Parameters

Field	Type	Required	Description
code	Int	Yes	Indicates whether the API call is successful. 0 means success or partial success, and other values indicate failure
message	String	Yes	Result description of the API call, explaining the return code
data	Array	No	A list of EUIDs corresponding to the user identifiers returned
identity_value	String	Yes	The value of the user identifier
euid	Long	Yes	The unique user ID corresponding to EngageLab MA
error_code	Int	Yes	Indicates whether the EUID retrieval is successful. 0 represents success, and other values represent failure

All Successful

{ "code": 0, "message": "success", "data": [ { "identity_value": "18012345678", // User identifier value "euid": 10362473, // Generated EUID, null if the acquisition fails "error_code": 0 // Corresponding error code, 0 for success, and not empty for failure, such as 40006 }, { "identity_value": "18012340000", "euid": 10362474, "error_code": 0 } ] }

              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "18012345678",   // User identifier value
            "euid": 10362473, // Generated EUID, null if the acquisition fails
            "error_code": 0   // Corresponding error code, 0 for success, and not empty for failure, such as 40006
        },
        {
            "identity_value": "18012340000",
            "euid": 10362474,
            "error_code": 0
        }
    ]
}

This code block in the floating window

All Failed

{ "code": 55101, "message": "Exceeded the limit of user identifiers" }

              
              {
    "code": 55101,
    "message": "Exceeded the limit of user identifiers"
}

This code block in the floating window

Partially Successful

{ "code": 0, "message": "success", "data": [ { "identity_value": "18012345678", // User identifier value "euid": null, // null for failure "error_code": -1 // Corresponding error code, 0 for success, and not empty for failure }, { "identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000", "euid": null, "error_code": 55105 } ] }

              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "18012345678",   // User identifier value
            "euid": null, // null for failure
            "error_code": -1     // Corresponding error code, 0 for success, and not empty for failure
        },
        {
            "identity_value": "1801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400008012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000180123400001801234000018012340000",
            "euid": null,
            "error_code": 55105
        }
    ]
}

This code block in the floating window

Error Code

Code	Description	Detailed Explanation
40050	Interface authentication failed.	Confirm whether the project ID and project secret key are correct.
40007	EUID is empty.	Please check the value of EUID.
50031	Project ID is invalid.	Please check whether the APIKey and APISecret are correct.
50034	Project ID does not exist.	Please check whether the APIKey and APISecret are correct, and whether the project has been deleted.
50074	API data source does not exist.	Please check whether the APIKey and APISecret are correct, and whether the API data source has been deleted.
55004	Business parameters are invalid.	Please check whether the fields of the request parameters are correct.
55101	The number of user identifiers exceeds the limit.	Confirm whether the number of values of the user identification exceeds 100.
55102	There are invalid user attribute names.	Confirm whether the attribute name meets the naming requirements, and whether it is empty/uses reserved characters/exceeds the length limit.
55103	User attribute values cannot be empty.	Confirm whether the value of the user attribute in the request body is empty.
55105	The value of the user identifier cannot exceed 256 characters.	Confirm whether the value of the user identification exceeds 256 characters.
55106	The name of the user identifier is not within the supported range.	Confirm whether the name of the user identification is user_id, anonymous_id, or registration_id.
55107	The value of the user identifier is empty.	Confirm whether the value of the user identification in the request body is empty.
55108	Invalid EUID.	Please check the value of EUID.
-1	Internal server error.	Please contact EngageLab technical support.