엔티티 끝점(프로필 액세스)
IMPORTANT프로필 액세스 API를 사용한 ExperienceEvent 조회는 더 이상 사용되지 않습니다. ExperienceEvents 조회가 필요한 사용 사례에 대해 계산된 속성과 같은 기능을 사용하십시오. 이 변경 사항에 대한 자세한 내용은 Adobe 고객 지원 센터에 문의하십시오.
Adobe Experience Platform을 사용하면 RESTful API 또는 사용자 인터페이스를 사용하여 Real-Time Customer Profile 데이터에 액세스할 수 있습니다. 이 안내서에서는 API를 사용하여 "프로필"로 더 일반적으로 알려진 엔티티에 액세스하는 방법을 간략하게 설명합니다. Experience Platform UI를 사용하여 프로필에 액세스하는 방법에 대한 자세한 내용은 프로필 사용 안내서를 참조하십시오.
시작하기
이 가이드에 사용된 API 끝점은 Real-Time Customer Profile API의 일부입니다. 계속하기 전에 시작 안내서를 검토하여 관련 문서에 대한 링크, 이 문서의 샘플 API 호출 읽기 지침 및 Experience Platform API를 성공적으로 호출하는 데 필요한 필수 헤더에 대한 중요 정보를 확인하십시오.
엔티티 검색
필요한 쿼리 매개 변수와 함께 /access/entities 끝점에 대한 GET 요청을 만들어 프로필 엔터티를 검색할 수 있습니다.
API 형식
GET /access/entities?{QUERY_PARAMETERS}
요청 경로에 제공된 쿼리 매개 변수는 액세스할 데이터를 지정합니다. 앰퍼샌드(&)로 구분된 여러 매개 변수를 포함할 수 있습니다.
프로필 엔터티에 액세스하려면 다음 쿼리 매개 변수를 제공해야 합니다.
schema.name: 엔터티의 XDM 스키마 이름입니다. 이 사용 사례에서는schema.name=_xdm.context.profile입니다.entityId: 검색하려는 엔터티의 ID입니다.entityIdNS: 검색하려는 엔터티의 네임스페이스입니다.entityId이(가) XID가 아님 인 경우 이 값을 제공해야 합니다.
부록의 쿼리 매개 변수 섹션에 올바른 매개 변수의 전체 목록이 제공됩니다.
요청
다음 요청은 ID를 사용하여 고객의 이메일과 이름을 검색합니다.
ID를 사용하여 엔티티를 검색하기 위한 샘플 요청
curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email&fields=identities,person.name,workEmail' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답은 요청된 엔터티와 함께 HTTP 상태 200을 반환합니다.
요청된 엔터티가 포함된 샘플 응답
{
"BVrqzwVv7o2p3naHvnsWpqZXv3KJgA": {
"entityId": "BVrqzwVv7o2p3naHvnsWpqZXv3KJgA",
"sources": [
"1000000000"
],
"entity": {
"identities": [
{
"id": "89149270342662559642753730269986316601",
"namespace": {
"code": "ecid"
}
},
{
"id": "janedoe@example.com",
"namespace": {
"code": "email"
}
},
{
"id": "johnsmith@example.com",
"namespace": {
"code": "email"
}
},
{
"id": "89149270342662559642753730269986316604",
"namespace": {
"code": "ecid"
}
},
{
"id": "58832431024964181144308914570411162539",
"namespace": {
"code": "ecid"
}
},
{
"id": "89149270342662559642753730269986316602",
"namespace": {
"code": "ecid"
},
"primary": true
}
],
"person": {
"name": {
"firstName": "Jane",
"middleName": "F",
"lastName": "Doe"
}
},
"workEmail": {
"primary": true,
"address": "janedoe@example.com",
"label": "Jane Doe",
"type": "work",
"status": "active"
}
},
"lastModifiedAt": "2018-08-28T20:57:24Z"
}
}
NOTE관련 그래프가 50개가 넘는 ID를 연결하는 경우 이 서비스는 HTTP 상태 422와 "관련 ID가 너무 많습니다"라는 메시지를 반환합니다. 이 오류가 표시되면 쿼리 매개 변수를 더 추가하여 검색 범위를 좁히는 것이 좋습니다.
API 형식
GET /access/entities?{QUERY_PARAMETERS}
요청 경로에 제공된 쿼리 매개 변수는 액세스할 데이터를 지정합니다. 앰퍼샌드(&)로 구분된 여러 매개 변수를 포함할 수 있습니다.
B2B 계정 데이터에 액세스하려면 다음 쿼리 매개 변수를 제공해야 합니다.
schema.name: 엔터티의 XDM 스키마 이름입니다. 이 사용 사례에서는 이 값이schema.name=_xdm.context.account입니다.entityId: 검색하려는 엔터티의 ID입니다.entityIdNS: 검색하려는 엔터티의 네임스페이스입니다.entityId이(가) XID가 아님 인 경우 이 값을 제공해야 합니다.
부록의 쿼리 매개 변수 섹션에 올바른 매개 변수의 전체 목록이 제공됩니다.
요청
B2B 계정 검색에 대한 샘플 요청
curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.account&entityIdNs=b2b_account&entityId=2334262' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답은 요청된 엔터티와 함께 HTTP 상태 200을 반환합니다.
요청된 엔터티가 포함된 샘플 응답
{
"GuQ-AUFjgjaeIw": {
"entityId": "GuQ-AUFjgjaeIw",
"mergePolicy": {
"id": "a6150f47-a94f-4c9d-bfa0-958a370020ee"
},
"sources": [
"er_m_attr"
],
"entity": {
"_id": "id1",
"extSourceSystemAudit": {
"lastReferencedDate": "2024-03-09 12:21:43.0",
"lastActivityDate": "2024-03-09 12:21:43.0",
"lastUpdatedDate": "2024-03-09 12:21:43.0",
"lastUpdatedBy": "{USER_ID}",
"externalKey": {
"sourceID": "{SOURCE_ID}",
"sourceKey": "{SOURCE_KEY}",
"sourceInstanceID": "{SOURCE_INSTANCE_ID}",
"sourceType": "{SOURCE_TYPE}"
},
"lastViewedDate": "2024-03-09 12:21:43.0",
"createdDate": "2024-03-09 12:21:43.0"
},
"accountID": "2334262",
"identityMap": {
"b2b_account": [
{
"id": "2334263"
},
{
"id": "2334262"
},
{
"id": "{SOURCE_ID}"
}
]
},
"isDeleted": false,
"accountKey": {
"sourceID": "2334262",
"sourceKey": "2334262",
"sourceInstanceID": "2334262",
"sourceType": "Random"
}
}
}
}
API 형식
GET /access/entities?{QUERY_PARAMETERS}
요청 경로에 제공된 쿼리 매개 변수는 액세스할 데이터를 지정합니다. 앰퍼샌드(&)로 구분된 여러 매개 변수를 포함할 수 있습니다.
B2B 영업 기회 엔터티에 액세스하려면 다음 쿼리 매개 변수를 제공해야 합니다.
schema.name: 엔터티의 XDM 스키마 이름입니다. 이 사용 사례에서는schema.name=_xdm.context.opportunity입니다.entityId: 검색하려는 엔터티의 ID입니다.entityIdNS: 검색하려는 엔터티의 네임스페이스입니다.entityId이(가) XID가 아님 인 경우 이 값을 제공해야 합니다.
부록의 쿼리 매개 변수 섹션에 올바른 매개 변수의 전체 목록이 제공됩니다.
요청
B2B 영업 기회 엔터티 검색에 대한 샘플 요청
curl -X GET 'https://platform.adobe.io/data/core/ups/access/entities?schema.name=_xdm.context.opportunity&entityIdNs=b2b_opportunity&entityId=2334262' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답은 요청된 엔터티와 함께 HTTP 상태 200을 반환합니다.
요청된 엔터티가 포함된 샘플 응답
{
"Ggw_AUFjgjaeIw": {
"entityId": "Ggw_AUFjgjaeIw",
"mergePolicy": {
"id": "162824be-07f5-4cd0-aa85-2ff3c8f6c775"
},
"sources": [
"er_m_attr"
],
"entity": {
"_id": "id1",
"extSourceSystemAudit": {
"lastReferencedDate": "2024-03-09 12:21:43.0",
"lastActivityDate": "2024-03-09 12:21:43.0",
"lastUpdatedDate": "2024-03-09 12:21:43.0",
"lastUpdatedBy": "{USER_ID}",
"externalKey": {
"sourceID": "00394S0001xpG6xABE",
"sourceKey": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce",
"sourceInstanceID": "00DC0000000Q35nMAC",
"sourceType": "Salesforce"
},
"lastViewedDate": "2024-03-09 12:21:43.0",
"createdDate": "2024-03-09 12:21:43.0"
},
"accountID": "2334262",
"identityMap": {
"b2b_opportunity": [
{
"id": "0043c329201xpG6xAAE@00DC0000000Q35nWIN.Salesforce"
},
{
"id": "2334263"
},
{
"id": "2334262"
}
]
},
"isDeleted": false,
"opportunityKey": {
"sourceID": "2334262",
"sourceKey": "2334262",
"sourceInstanceID": "2334262",
"sourceType": "Random"
},
"accountKey": {
"sourceID": "2334262",
"sourceKey": "2334262",
"sourceInstanceID": "2334262",
"sourceType": "Random"
}
}
}
}