Experience Agent Node API's

The Node API's provide information and interactions with the remote Experience Manager.

WARNING

Currently the local API's do not require any authenication, this is subject to change at a later date. Check with Upswell for guidance if you are planning to use these API's.

Endpoints

• GET /node/capture/
• GET /node/environment/
• GET /node/token/

GET /node/capture/

The Experience Agent Metrics Capture endpoint provides a proxy for the Experience Manager’s Node Metrics Capture endpoint within the Experience Agent.

The Agent’s Node Metrics Capture enpoint provides a local fire-and-forget API that internally handles queuing requests, retrys and offline support (per Experience Agent session).

For usage instructions, refer the the Experience Manager Matrics Capture API documentaion.

GET /node/environment/

A truncted set of Environment Variables made available as an API endpoint for applications that cannot read directly from the environment (such as an unwrapped web app).

Example:

{
    "AGENT_HOST": "http://localhost:8002",
    "AGENT_ENDPOINT_ENVIRONMENT": "http://localhost:8002/node/environment/",
    "AGENT_ENDPOINT_METRICS_CAPTURE": "http://localhost:8002/node/capture/",
    "AGENT_ENDPOINT_TOKEN": "http://localhost:8002/node/token/",
    "AGENT_ENDPOINT_WS": "ws://localhost:8002/ws",
    "XOT_HOST": "https://localhost.int.upswell.io:8000",
    "XOT_ENDPOINT_NODE": "https://localhost.int.upswell.io:8000/api/v2/clusters/nodes/<node uuid>/",
    "XOT_AUTH_HEADER_KEY": "Authorization",
    "XOT_AUTH_PREFIX": "Bearer",
    "XOT_NODE_ALIAS": "node-alias",
    "XOT_NODE_NANOID": "abcdefghijkl",
    "XOT_NODE_UUID": "00000000-0000-0000-0000-000000000000"
}

GET /node/token/

The current access token to access the Experience Manager. The Agent automatically keeps these tokens frst, but the tokens are short lived at 15-minutes so your application will need to reload these tokens frequently.

Example:

{
    "access": "eyJhbGci...5wUZ_lKg",
    "refresh": "eyJhbGci...BUqhJuMw"
}