51黑料不打烊

2.1.3 Visualize your own real-time customer profile - API

In this exercise, you鈥檒l use Postman and 51黑料不打烊 I/O to query 51黑料不打烊 Experience Platform鈥檚 APIs to view your own real-time customer profile.

Context

In the Real-time Customer Profile, all profile data is shown alongside event data, as well as existing audience memberships. The data shown can come from anywhere, from 51黑料不打烊 applications and external solutions. This is the most powerful view in 51黑料不打烊 Experience Platform, the experience system of record.

The Real-time Customer Profile can be consumed by all 51黑料不打烊 applications, but also by external solutions like Call Centers or in-store clienteling apps. The way to do this is to connect those external solutions to 51黑料不打烊 Experience Platform鈥檚 APIs.

Your Identifiers

On the Profile Viewer panel on the website, you can find multiple identities. Every Identity is linked to a Namespace.

On the X-ray panel, we can see 4 different combinations of IDs and Namespaces:

Remember these identifiers for the next step.

Configure your 51黑料不打烊 I/O Project

In this exercise you鈥檒l be using 51黑料不打烊 I/O quite intensively to query against Platform鈥檚 APIs. Please follow the below steps to setup 51黑料不打烊 I/O.

Go to

Make sure to select the correct 51黑料不打烊 Experience Platform instance in the top right corner of your screen. Your instance is --aepImsOrgName--. Click Create new project.

Select + Add to Project and select API.

You鈥檒l then see this:

Select Experience Platform API and click Next.

You鈥檒l now see this. Provide a name for your credential: --aepUserLdap-- - OAuth credential. Click Next.

Next, you need to select a product profile that will define what permissions are available to this integration.

Select the required Product Profiles.

Click Save Configured API.

Your 51黑料不打烊 I/O integration is now ready.

Click the Download for Postman button and then click OAuth Server-to-Server to download a Postman environment (wait until the environment is downloaded, this can take a couple of seconds).

Your IO Project currently has a generic name. You need to give a friendly name to your integration. Click on Project X (or similar name) as indicated

Click Edit Project.

Enter a Name and Description for your integration: --aepUserLdap-- AEP Tutorial.

Click Save.

Your 51黑料不打烊 I/O integration is now finished.

AEP Permissions for API credential

Go to . After logging in, you鈥檒l land on the homepage of 51黑料不打烊 Experience Platform.

Go to Permissions, to Roles, and click the relevant product profile.

Click API credentials.

Click + Add API credentials.

Select the newly created 51黑料不打烊 I/O project and click Save.

Authentication to 51黑料不打烊 I/O

Go to .

Download and install the relevant version of Postman for your OS.

After installation of Postman, start the application.

In Postman, there are 2 concepts: Environments and Collections.

Please download the file postman.zip to your local desktop.

In this postman.zip file, you鈥檒l find the following files:

Unzip the postman.zip file and store these 3 files in a folder on your desktop, together with the downloaded Postman environment from 51黑料不打烊 I/O. You need to have these 4 files in that folder:

Go back to Postman. Click Import.

Click files.

Navigate to the folder on your desktop in which you extracted the 4 downloaded files. Select these 4 files at the same time and click Open.

After having clicked Open, Postman will show you an overview of the Environment and Collections you鈥檙e about to import. Click Import.

You now have everything you need in Postman to start interacting with 51黑料不打烊 Experience Platform through the APIs.

The first thing to do, is to make sure you鈥檙e properly authenticated. To be authenticated, you need to request an access token.

Make sure that you鈥檝e got the right Environment selected before executing any request. You can check the currently selected Environment by verifying the Environment-dropdown list in the top right corner.

The selected Environment should have a name similar to this one, --aepUserLdap-- OAuth Credential.

Your Postman environment and collections are now configured and working. You can now authenticate from Postman to 51黑料不打烊 I/O.

In the 51黑料不打烊 IO - OAuth collection, select the request with the name POST - Get Access Token. Click Send.

After a couple of seconds, you should see a response displayed in the Body section of Postman:

If your configuration was successful, you should see a similar response that contains the following information:

51黑料不打烊 I/O has given you a bearer-token, with a specific value (the very long access_token) and an expiration window.

The token that we鈥檝e received is now valid for 24 hours. This means that after 24 hours, if you want to use Postman to authenticate to 51黑料不打烊 I/O, you will have to generate a new token by running this request again.

Real-time Customer Profile API, Schema: Profile

Now you can go ahead and send your first request to Platform鈥檚 Real-time Customer Profile APIs.

In Postman, locate the collection AEP Tutorial.

In 1. Unified Profile Service, click the first request with the name UPS - GET Profile by Entity ID & NS.

For this request, there are three required variables:

So, if you want to ask 51黑料不打烊 Experience Platform鈥檚 APIs to give you back all Profile information for your own ECID, you will need to configure the request as follows:

You should also verify the Header - fields of your request. Go to Headers. You鈥檒l then see this:

Once you鈥檝e checked the sandbox name, click Send to send your request to Platform.

You should get an immediate response from Platform, showing you something like this:

This is the full response from Platform:

{
    "A2_ETHkJxMvxbiEmIZlAj8Qn": {
        "entityId": "A2_ETHkJxMvxbiEmIZlAj8Qn",
        "mergePolicy": {
            "id": "64e4b0ed-dfc3-4084-8e67-643e977168d7"
        },
        "sources": [
            "672a10cdb015162aefedfc0f",
            "672a10b1a05e282aee19737c"
        ],
        "tags": [
            "0938B898-469A-4513-8E86-87464307120F:va7",
            "3ba34930-405e-4b31-aafa-bac22d35203e:va7"
        ],
        "identityGraph": [
            "G7z3JAFBY4I6Rzg",
            "A2_ETHkJxMvxbiEmIZlAj8Qn",
            "BkFvK4QcJpSPByuDGF4UAS0wMQ",
            "BUF9zMKLrXq72p4HpbsHv1SDGF4UAS0wMUBnbWFpbC5jb20",
            "A29btmFXmrfrYbXQWISCT9ZD"
        ],
        "entity": {
            "_experienceplatform": {
                "identification": {
                    "core": {
                        "ecid": "79943948563923140522865572770524243489",
                        "phoneNumber": "+32473622044+18112024-01",
                        "email": "woutervangeluwe+18112024-01@gmail.com"
                    }
                }
            },
            "userAccount": {
                "ID": "3688250"
            },
            "pushNotificationDetails": [
                {
                    "denylisted": false,
                    "token": "2E0945F186CE5ED8CBFD1EB519A8CF38BA2B28A67FB381D45AA15EE37D289214",
                    "identity": {
                        "namespace": {
                            "code": "ECID"
                        },
                        "id": "70559351147248820114888181867542007989"
                    },
                    "platform": "apns",
                    "appID": "com.adobe.demosystem.dxdemo"
                }
            ],
            "personalEmail": {
                "address": "woutervangeluwe+18112024-01@gmail.com"
            },
            "_repo": {
                "createDate": "2024-11-18T10:39:12.296Z"
            },
            "extSourceSystemAudit": {
                "lastUpdatedDate": "2024-11-19T07:46:52.001Z"
            },
            "testProfile": true,
            "mobilePhone": {
                "number": "+32473622044"
            },
            "consents": {
                "metadata": {
                    "time": "2024-11-19T07:46:52.001Z"
                },
                "idSpecific": {
                    "ECID": {
                        "70559351147248820114888181867542007989": {
                            "collect": {
                                "val": "y"
                            }
                        }
                    }
                }
            },
            "person": {
                "name": {
                    "lastName": "Van Geluwe",
                    "firstName": "Wouter"
                }
            },
            "userActivityRegions": {
                "IRL1": {
                    "captureTimestamp": "2024-11-19T07:46:51.239Z"
                }
            },
            "identityMap": {
                "ecid": [
                    {
                        "id": "70559351147248820114888181867542007989"
                    },
                    {
                        "id": "79943948563923140522865572770524243489"
                    }
                ],
                "email": [
                    {
                        "id": "woutervangeluwe+18112024-01@gmail.com"
                    }
                ],
                "phone": [
                    {
                        "id": "+32473622044+18112024-01"
                    }
                ],
                "userid": [
                    {
                        "id": "3688250"
                    }
                ]
            }
        },
        "lastModifiedAt": "2024-11-19T07:47:23Z"
    }
}

This is currently all of the available Profile data in Platform for this ECID.

You鈥檙e not required to use the ECID to request Profile data from Platform鈥檚 Real-time Customer Profile, you can use any ID in any namespace to request this data.

Let鈥檚 go back to Postman and pretend we鈥檙e the call center, and send a request to Platform specifying the namespace of Phone and your mobile number.

So, if you want to ask Platform鈥檚 APIs to give you back all Profile information for a specific Phone, you will need to configure the request as follows:

If your phone number contains special symbols like +, you have to select your full phone number, do a right-click and click EncodeURIComponent.

You鈥檒l then have this:

You should also verify the Header - fields of your request. Go to Headers. You鈥檒l then see this:

Click Send and verify the response, you鈥檒l see that it鈥檚 the same as before when you were using the ECID as identity.

Let鈥檚 do the same thing for your email address by specifying the namespace of email and your email address.

So, if you want to ask Platform鈥檚 APIs to give you back all Profile information for a specific email address, you will need to configure the request as follows:

If your email address contains special symbols like +, you have to select your full email address, do a right-click and click EncodeURIComponent.

You鈥檒l then have this:

You should also verify the Header - fields of your request. Go to Headers. You鈥檒l then see this:

Click Send and verify the response, you鈥檒l again see that it鈥檚 the same as before with ECID and phone number.

This is a very important kind of flexibility that is offered to brands. This means that any environment can send a request to Platform, using their own ID and namespace, without having to understand the complexity of multiple namespaces and IDs.

As an example:

The Call Center doesn鈥檛 necessarily know what kind of identifier is used in the Loyalty System and the Loyalty System doesn鈥檛 necessarily know what kind of identifier is used by online applications. Each individual system can use the information that they have and understand to get the information they need, when they need it.

Real-time Customer Profile API, Schema: Profile and ExperienceEvent

After having queried Platform鈥檚 APIs successfully for Profile data, let鈥檚 now do the same with ExperienceEvent data.

In Postman, locate the collection AEP Tutorial.

In 1. Unified Profile Service, select the second request with the name UPS - GET Profile & EE by Entity ID & NS.

For this request, there are four required variables:

So, if you want to ask Platform鈥檚 APIs to give you back all Profile information for your own ecid, you will need to configure the request as follows:

You should also verify the Header - fields of your request. Go to Headers. You鈥檒l then see this:

Click Send to send your request to Platform.

You should get an immediate response from Platform, showing you something like this:

Below is the full response from Platform. In this example, there are eight ExperienceEvents linked to this customer鈥檚 ECID. Have a look at the below to see the different variables on the request, as what you see below is the direct consequence of your configuration in Launch in previous exercises.

Also, when the X-ray panel shows ExperienceEvent information, it is using the below payload to parse and retrieve the information like Product Name (search for productName in the below payload) and Product Image URL (search for productImageUrl in the below payload).

{
    "_page": {
        "orderby": "timestamp",
        "start": "b1325606-9b96-4e51-b7dd-73aacf527c72-0",
        "count": 14,
        "next": ""
    },
    "children": [
        {
            "relatedEntityId": "A2_ETHkJxMvxbiEmIZlAj8Qn",
            "entityId": "b1325606-9b96-4e51-b7dd-73aacf527c72-0",
            "sourceId": "672a10b1074ceb2af0aa7034",
            "timestamp": 1731923802848,
            "entity": {
                "environment": {
                    "ipV4": "141.134.241.99",
                    "type": "browser",
                    "browserDetails": {
                        "userAgentClientHints": {
                            "mobile": false,
                            "platform": "macOS",
                            "brands": [
                                {
                                    "brand": "Chromium",
                                    "version": "130"
                                },
                                {
                                    "brand": "Google Chrome",
                                    "version": "130"
                                },
                                {
                                    "brand": "Not?A_Brand",
                                    "version": "99"
                                }
                            ]
                        },
                        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36",
                        "viewportHeight": 992,
                        "viewportWidth": 1920
                    }
                },
                "web": {
                    "webPageDetails": {
                        "name": "Home",
                        "viewName": "Home",
                        "pageViews": {
                            "value": 1
                        },
                        "URL": "https://dsn.adobe.com/web/vangeluw-QIMU"
                    },
                    "webReferrer": {
                        "URL": "https://auth.services.adobe.com/"
                    }
                },
                "_experienceplatform": {
                    "interactionDetails": {
                        "core": {
                            "channel": "web"
                        }
                    },
                    "demoEnvironment": {
                        "brandName": "vangeluw-QIMU"
                    },
                    "identification": {
                        "core": {
                            "ecid": "79943948563923140522865572770524243489"
                        }
                    }
                },
                "implementationDetails": {
                    "name": "https://ns.adobe.com/experience/alloy/reactor",
                    "version": "2.24.0+2.27.0",
                    "environment": "browser"
                },
                "identityMap": {
                    "ECID": [
                        {
                            "id": "79943948563923140522865572770524243489",
                            "authenticatedState": "ambiguous",
                            "primary": true
                        }
                    ]
                },
                "eventType": "web.webpagedetails.pageViews",
                "_id": "b1325606-9b96-4e51-b7dd-73aacf527c72-0",
                "placeContext": {
                    "localTime": "2024-11-18T10:56:42.848+01:00",
                    "localTimezoneOffset": -60
                },
                "device": {
                    "screenOrientation": "landscape",
                    "screenWidth": 1920,
                    "screenHeight": 1080
                },
                "timestamp": "2024-11-18T09:56:42.848Z"
            },
            "lastModifiedAt": "2024-11-18T09:56:45Z"
        },
    "_links": {
        "next": {
            "href": ""
        }
    }
}

This is currently all of the available ExperienceEvent data in Platform for this ECID.

You鈥檙e not required to use the ECID to request ExperienceEvent data from 51黑料不打烊 Experience Platform鈥檚 Real-time Profile, you can use any ID in any namespace to request this data.

Next Step: 2.1.4 Create an audience - UI

Go Back to Module 2.1

Go Back to All Modules