시작하기 REST APIs

일반 요구 사항, 인증, 선택적 쿼리 매개 변수, 요청에 대한 정보 URLs, 및 기타 참조.

API 요구 사항 및 권장 사항

작업 시 수행해야 하는 작업 Audience Manager APIs.

작업 시 다음 사항에 주의하십시오 Audience Manager API 코드:

• 요청 매개 변수: 별도로 지정하지 않는 한 모든 요청 매개 변수가 필요합니다.
• 헤더 요청: 사용 시 Adobe Developer 토큰을 지정하는 경우 x-api-key 헤더. 당신은 당신의 API 키를 눌러 서비스 계정 통합 페이지.
• JSON콘텐츠 유형: 지정 content-type: application/json 및 accept: application/json 코드가 있어야 합니다.
• 요청 및 응답: 올바른 형식으로 요청 보내기 JSON 개체. Audience Manager 다음으로 응답 JSON 형식이 지정된 데이터. 서버 응답에는 요청된 데이터, 상태 코드 또는 둘 다 포함될 수 있습니다.
• 액세스: 사용자 Audience Manager 컨설턴트는 다음을 수행할 수 있는 클라이언트 ID와 키를 제공합니다 API 요청.
• 설명서 및 코드 샘플: 텍스트 입력 기울임체 는 만들거나 받을 때 제공하거나 전달하는 변수를 나타냅니다 API 데이터. 바꾸기 기울임꼴 자체 코드, 매개 변수 또는 기타 필수 정보가 있는 텍스트.

인증

다음 Audience Manager REST APIs 두 가지 인증 방법을 지원합니다.

• JWT(서비스 계정) 인증 사용 Adobe Developer. Adobe Developer 는 Adobe의 개발자 에코시스템과 커뮤니티입니다. 여기에는 다음이 포함됩니다 모든 Adobe 제품에 대한 API. 권장되는 설정 및 사용 방법입니다 Adobe APIs.
• OAuth 인증(더 이상 사용되지 않음). 이 메서드는 더 이상 사용되지 않지만, 기존 고객은 OAuth 통합은 이 메서드를 사용하여 계속 진행할 수 있습니다.

JWT (Service Account) Adobe Developer을 사용한 인증

Adobe Developer 개요

Adobe Developer 는 Adobe의 개발자 에코시스템과 커뮤니티입니다. 여기에는 다음이 포함됩니다 모든 Adobe 제품에 대한 API.

권장되는 설정 및 사용 방법입니다 Adobe APIs.

사전 요구 사항

구성하기 전에 JWT 인증, 액세스 권한이 있는지 확인합니다. Adobe Developer 콘솔 in Adobe Developer. 액세스 요청에 대해서는 조직 관리자에게 문의하십시오.

인증

아래 절차를 수행하여 을 구성합니다 JWT (Service Account) 를 사용하여 인증 Adobe Developer:

1. 에 로그인합니다. Adobe Developer 콘솔.
2. 다음 단계를 수행합니다. 서비스 계정 연결.
   • 다음 기간 동안 2단계: 서비스 계정 인증을 사용하여 프로젝트에 API 추가을(를) 선택하고 을(를) 선택합니다. Audience Manager API 선택 사항입니다.
3. 먼저 연결부터 해 보세요 API 의 지침에 따라 을 호출합니다. 3단계.

기술 계정 RBAC 권한

Audience Manager 계정이 역할 기반 액세스 제어, Audience Manager 기술 사용자 계정을 만들고 API를 호출하는 Audience Manager RBAC 그룹에 추가해야 합니다.

기술 사용자 계정을 만들고 RBAC 그룹에 추가하려면 아래 단계를 따르십시오.

1. 만들기 GET 호출 https://aam.adobe.io/v1/users/self. 이 호출되면 Admin Console에서 Users 페이지.

   

2. Audience Manager 계정에 로그인하고 기술 사용자 계정 추가 를 추가합니다.

OAuth 인증(더 이상 사용되지 않음)

다음 Audience Manager REST API 다음 OAuth 2.0 토큰 인증 및 갱신에 대한 표준. 아래 섹션에서는 를 인증하고 작업을 시작하는 방법에 대해 설명합니다 APIs.

일반 만들기 API 사용자

을 사용하여 작업할 별도의 기술 사용자 계정을 만드는 것이 좋습니다 Audience Manager APIs. 조직의 특정 사용자에게 연결되어 있지 않거나 관련 없는 일반 계정입니다. 이러한 유형의 API 사용자 계정은 다음 두 가지 작업을 수행하는 데 도움이 됩니다.

• 서비스 호출 식별 API (예: API또는 API 요청).
• 에 대한 중단 없는 액세스 제공 APIs. 특정 사용자에 연결된 계정은 회사를 나갈 때 삭제할 수 있습니다. 이를 통해 사용 가능한 API 코드가 있어야 합니다. 특정 직원에 연결되지 않은 일반 계정은 이 문제를 방지하는 데 도움이 됩니다.

이러한 유형의 계정에 대한 예나 사용 사례로서, 벌크 관리 도구. 이를 위해서는 사용자 계정이 필요합니다 API 액세스 권한. 특정 사용자에게 권한을 추가하는 대신 특정 사용자를 제외한 모든 권한을 만듭니다. API 적절한 자격 증명, 키 및 암호가 있는 사용자 계정 API 호출. 이 기능은 Audience Manager APIs.

작업 Audience Manager 일반을 설정하는 컨설턴트요 API-전용 사용자 계정입니다.

암호 인증 워크플로우

암호 인증 보안 액세스 REST API. 아래 단계는 JSON 브라우저에서 클라이언트

1단계: 요청 API 액세스

파트너 솔루션 관리자에게 문의하십시오. 그러면 다음과 같은 메시지가 제공됩니다 API 클라이언트 ID 및 암호입니다. ID 및 암호가 API.

참고: 새로 고침 토큰을 받으려면 요청 시 을 지정합니다 API 액세스 권한.

2단계: 토큰 요청

선호하는 토큰 요청으로 토큰 요청 전달 JSON 클라이언트. 요청을 작성하는 경우:

• 다음 작업 POST 호출 방법 https://api.demdex.com/oauth/token.
• 클라이언트 ID와 암호를 기본-64 인코딩 문자열로 변환합니다. 전환 프로세스 중에 ID와 암호를 콜론으로 구분합니다. 예를 들어 자격 증명이 있습니다 testId : testSecret 변환 dGVzdElkOnRlc3RTZWNyZXQ=.
• 에 전달 HTTP headers Authorization:Basic <base-64 clientID:clientSecret> 및 Content-Type: application/x-www-form-urlencoded . 예를 들어 헤더는 다음과 같을 수 있습니다.
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• 다음과 같이 요청 본문을 설정합니다.
  
  grant_type=password&username=<your-AudienceManager-user-name>&password=<your-AudienceManager-password>

3단계: 토큰 받기

다음 JSON 응답에는 액세스 토큰이 포함되어 있습니다. 응답은 다음과 같습니다.

{
    "access_token": "28fed402-eafd-456c-9341-ac753f25bbbc",
    "token_type": "bearer",
    "refresh_token": "b27122c0-b0c7-4b39-a71b-1547a3b3b88e",
    "expires_in": 21922,
    "scope": "read write"
}

다음 expires_in key 는 액세스 토큰이 만료될 때까지 남은 시간(초)을 나타냅니다. 토큰을 노출하는 경우 짧은 만료 시간을 사용하여 노출을 제한하는 것이 좋습니다.

토큰 새로 고침

토큰 새로 고침 갱신 API 원래 토큰이 만료된 후 액세스합니다. 요청한 경우 응답입니다 JSON 암호 워크플로우에서 새로 고침 토큰이 포함됩니다. 새로 고침 토큰을 받지 않은 경우 암호 인증 프로세스를 통해 새 토큰을 만드십시오.

기존 액세스 토큰이 만료되기 전에 새로 고침 토큰을 사용하여 새 토큰을 생성할 수도 있습니다.

액세스 토큰이 만료되면 401 Status Code 및 응답에 다음 헤더가 있습니다.

WWW-Authenticate: Bearer realm="oauth", error="invalid_token", error_description="Access token expired: <token>"

다음 단계는 새로 고침 토큰을 사용하여 새 액세스 토큰을 생성하는 워크플로우의 개요를 설명합니다. JSON 브라우저에서 클라이언트

1단계: 새 토큰 요청

선호하는 값으로 새로 고침 토큰 요청을 전달합니다 JSON 클라이언트. 요청을 작성하는 경우:

• 다음 작업 POST 호출 방법 https://api.demdex.com/oauth/token.
• 클라이언트 ID와 암호를 기본-64 인코딩 문자열로 변환합니다. 전환 프로세스 중에 ID와 암호를 콜론으로 구분합니다. 예를 들어 자격 증명이 있습니다 testId : testSecret 변환 dGVzdElkOnRlc3RTZWNyZXQ=.
• HTTP 헤더에 전달 Authorization:Basic <base-64 clientID:clientSecret> 및 Content-Type: application/x-www-form-urlencoded. 예를 들어 헤더는 다음과 같을 수 있습니다.
  Authorization: Basic dGVzdElkOnRlc3RTZWNyZXQ=
Content-Type: application/x-www-form-urlencoded
• 요청 본문에서 grant_type:refresh_token 이전 액세스 요청에서 받은 새로 고침 토큰을 전달합니다. 요청은 다음과 같아야 합니다.
  grant_type=refresh_token&refresh_token=b27122c0-b0c7-4b39-a71b-1547a3b3b88e

2단계: 새 토큰 받기

다음 JSON 응답에는 새 액세스 토큰이 포함됩니다. 응답은 다음과 같습니다.

{
    "access_token": "4fdfc261-2ffc-4fb7-8dbd-64221714c45f",
    "token_type": "bearer",
    "refresh_token": "295fa487-1825-4caa-a715-80b81ac17dae",
    "expires_in": 21922,
    "scope": "read write"
}

인증 코드 및 암시적 인증

다음 Audience Manager REST API 는 인증 코드 및 암시적 인증을 지원합니다. 이러한 액세스 방법을 사용하려면 사용자가 로그인해야 합니다 https://api.demdex.com/oauth/authorize 액세스 및 새로 고침 토큰.

인증됨 만들기 API 요청

호출 요구 사항 API 인증 토큰을 받은 후의 메서드입니다.

사용 가능한 을 호출하려면 API 메서드:

• 에서 HTTP 헤더, 설정 Authorization: Bearer <token>.
• 사용 시 JWT(서비스 계정) 인증를 채울 때는 x-api-key header. client_id. 당신은 당신의 client_id 에서 Adobe Developer 통합 페이지.
• 필요한 를 호출합니다 API 메서드를 사용합니다.

선택 사항입니다 API 쿼리 매개 변수

개체의 모든 속성을 반환하는 메서드에 사용할 수 있는 선택적 매개 변수를 설정합니다.

다음과 같은 선택적 매개 변수를 API 반환 메서드 모두 개체의 속성입니다. 해당 쿼리를 API.

페이지 옵션에 대한 참고 사항

페이지 정보 is not 지정한 경우 요청이 일반 을 반환합니다 JSON 결과로 배열이 발생합니다. 페이지 정보인 경우 is 지정한 경우 반환된 목록이 JSON 합계 결과 및 현재 페이지에 대한 정보가 들어 있는 개체입니다. 페이지 옵션을 사용하는 샘플 요청은 다음과 유사할 수 있습니다.

GET https://aam.adobe.io/v1/models/?page=1&pageSize=2&search=Test

API URLs

URLs 요청, 스테이징 및 프로덕션 환경, 버전에 대해 설명합니다.

요청 URLs

다음 표에는 요청이 나와 있습니다 URLs 를 전달하는 데 사용됨 API 요청, 메서드

사용하는 인증 방법에 따라 요청을 조정해야 합니다 URLs 아래의 표에 따라.

요청 URLs 대상 JWT 인증

요청 URLs 대상 OAuth 인증(더 이상 사용되지 않음)

환경

다음 Audience Manager API는 다양한 작업 환경에 대한 액세스를 제공합니다. 이러한 환경은 라이브 프로덕션 데이터에 영향을 주지 않고 별도의 데이터베이스에 대해 코드를 테스트하는 데 도움이 됩니다. 다음 표에는 사용 가능한 항목이 나와 있습니다 API 환경 및 해당 리소스 호스트 이름

사용하는 인증 방법에 따라 환경을 조정해야 합니다 URLs 아래 표에 나와 있습니다.

버전

이러한 API정기적으로 출시됩니다. 새 릴리스는 API 버전 번호. 버전 번호가 요청에서 참조됩니다 URL 로서의 v<version number> 다음 예와 같이,

https://<host>/v1/...

정의된 응답 코드

HTTP 에서 반환된 상태 코드 및 응답 텍스트 Audience Manager REST API.

Business.Adobe.com 리소스

Third Party Integrations Third Party Data Customer Journey Analytics Mobile Analytics Audience Segmentation General Data Protection Regulation