API users

Visitor

GET https://api.commander1.com/v1.0/engage/visitors/

This endpoint allows you to get properties for one specific visitor. When you create the token, you can define which properties to return.

This API is more designed to be called from a tag in each user's browser.

Query Parameters

Name	Type	Description
callback	string	(optional) Callback for jsonp request
token	string	Security token
site	integer	ID of the site
tcid	string	Cookie id. If empty (recommanded) it will read the tcid in the user's cookie.

200

{
    "user_age": 39,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

First-party usage

If your site uses a first-party domain (either through a dedicated subdomain or through the Commanders Act Gateway path), API calls must be made on your own domain.

Important: the URL must include /api/ in the path. Without this path, the request will not work.

1. Using a dedicated subdomain (example: tracking.mydomain.com)

The first-party API structure must follow this pattern: https://tracking.mydomain.com/api/1.0/engage/visitors/

Example: https://tracking.mydomain.com/api/v1.0/engage/visitors/?site=5326&tcid=&token=XXXX

2. Using Commanders Act Gateway (path-based setup)

If your gateway endpoint is served under a path (for example: https://www.mydomain.com/cact-proxy/), the first-party API structure must follow this pattern: https://www.mydomain.com/cact-proxy/api/1.0/engage/visitors/

Example: https://www.mydomain.com/cact-proxy/api/v1.0/engage/visitors/?site=5326&tcid=&token=XXXX

Note: always keep the /api//… structure after the subdomain or the gateway path.

User

GET https://api.commander1.com/engage/user/

This endpoint allows you to get properties for one specific user based on a user_id. When you create the token, you can define which properties to return.

Query Parameters

Name	Type	Description
token	string	Security token
user_id	string	ID of the user
site	integer	ID of the site

200 Consent successfully retrieved.

{
    "user_age": 39,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

404 Could not find a user matching this query.

Do not use this endpoint client-side

The GET User endpoint must not be called from the browser. Exposing the token would allow anyone to capture it and loop through user IDs to extract all user data.

Use this API server-side only in a secure backend environment.

User

PUT https://api.commander1.com/engage/user/

Insert or update a user

Query Parameters

Name	Type	Description
site	string	Id of the site (account)
user_id	string	Id of the user.
token	string	Security token

200

{"success":true}

Example Request

PUT

https://api.commander1.com/engage/user/?site=1234&user_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

//Format example
{
    "person": {
        "id": "10000000",
        "card": "12345678910",
        "email": "[email protected]",
        "gender": "female",
        "firstname": "Joan",
        "lastname": "Craig",
        "custom": {
            "area_number": 123
        },
    ...
    }
}

DELETE user

Delete a user

Resource URL

https://api.commander1.com/engage/user/

Resource Information

Response formats	JSON
Requires authentication?	Yes (token)

Parameters

NAME	REQUIREMENT	EXAMPLE VALUES	DESCRIPTION
site	d+	1234	Id of the site
user_id	d+	1234	Id of the user
tc_id (optional)	d+	1234	Id of the visitor
token	[a-zA-Z0-9]*	WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA	Security token

Example Request

DELETE

https://api.commander1.com/engage/user/?site=1234&user_id=1234&tc_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

Response

{"success":true}