REST APIs 시작 getting-started-with-rest-apis

Adobe Developer 개요 adobeio

Adobe Developer은(는) Adobe의 개발자 생태계 및 커뮤니티입니다. 여기에는 모든 Adobe 제품에 대한 API가 포함됩니다.

Adobe APIs을(를) 설정하고 사용하는 데 권장되는 방법입니다.

전제 조건 prerequisites

JWT 인증을 구성하려면 먼저 Adobe Developer에서 Adobe Developer Console에 액세스할 수 있는지 확인하십시오. 액세스 요청에 대해서는 조직 관리자에게 문의하십시오.

인증 auth

Adobe Developer을(를) 사용하여 JWT (Service Account) 인증을 구성하려면 아래 단계를 따르십시오.

1. Adobe Developer Console에 로그인합니다.
2. 서비스 계정 연결의 단계를 따릅니다.
   • 2단계: 서비스 계정 인증을 사용하여 프로젝트에 API를 추가하는 동안 Audience Manager API 옵션을 선택하십시오.
3. 3단계의 지침에 따라 첫 번째 API 통화를 수행하여 연결을 시도하십시오.

기술 계정 RBAC 권한

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

아래 단계에 따라 기술 사용자 계정을 만들고 RBAC 그룹에 추가합니다.

1. https://aam.adobe.io/v1/users/self에 GET 통화를 합니다. 이 호출은 Users 페이지의 Admin Console에서 볼 수 있는 기술 사용자 계정을 만듭니다.

   

2. Audience Manager 계정에 로그인하고 기술 사용자 계정을 API를 호출할 사용자 그룹에 추가합니다.

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

일반 API 사용자 만들기 requirements

Audience Manager API (으)로 작업하려면 별도의 기술 사용자 계정을 만드는 것이 좋습니다. 조직의 특정 사용자와 연결되거나 연결되지 않은 일반 계정입니다. 이 유형의 API 사용자 계정은 다음 두 가지 작업을 수행하는 데 도움이 됩니다.

• API을(를) 호출하는 서비스(예: API을(를) 사용하는 앱이나 API개의 요청을 하는 다른 도구의 호출)를 식별합니다.
• API에 중단 없이 액세스하십시오. 특정 사용자에 연결된 계정은 회사에서 나갈 때 삭제될 수 있습니다. 이 경우 사용 가능한 API 코드를 사용할 수 없습니다. 특정 직원에게 연결되지 않은 일반 계정은 이 문제를 방지하는 데 도움이 됩니다.

이 유형의 계정에 대한 사용 사례로 대량 관리 도구를 사용하여 한 번에 많은 세그먼트를 변경한다고 가정해 보겠습니다. 이렇게 하려면 사용자 계정에 API 액세스 권한이 필요합니다. 특정 사용자에게 권한을 추가하는 대신 API을(를) 호출할 수 있는 적절한 자격 증명, 키 및 암호가 있는 비특정 API 사용자 계정을 만듭니다. Audience Manager API을(를) 사용하는 자체 응용 프로그램을 개발하는 경우에도 유용합니다.

Audience Manager 컨설턴트와 함께 일반 API 전용 사용자 계정을 설정합니다.

암호 인증 워크플로 password-authentication-workflow

암호 인증은 REST API에 안전하게 액세스합니다. 아래 단계에서는 브라우저의 JSON 클라이언트에서 암호 인증을 위한 워크플로에 대해 간략히 설명합니다.

1단계: API 액세스 요청

파트너 솔루션 관리자에게 문의하십시오. API 클라이언트 ID와 암호를 제공합니다. ID 및 암호가 API에 대해 사용자를 인증합니다.

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

2단계: 토큰 요청

선호하는 JSON 클라이언트로 토큰 요청을 전달합니다. 요청을 빌드할 때:

• POST 메서드를 사용하여 https://api.demdex.com/oauth/token을(를) 호출하십시오.
• 클라이언트 ID 및 암호를 base-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 키는 액세스 토큰이 만료될 때까지의 시간(초)을 나타냅니다. 토큰이 노출된 경우 짧은 만료 시간을 사용하여 노출을 제한하는 것이 좋습니다.

토큰 새로 고침 refresh-token

토큰 새로 고침은 원본 토큰이 만료된 후 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 및 암호를 base-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"
}

인증 코드 및 암시적 인증 authentication-code-implicit

Audience Manager REST API은(는) 인증 코드와 암시적 인증을 지원합니다. 이러한 액세스 방법을 사용하려면 사용자가 https://api.demdex.com/oauth/authorize에 로그인하여 액세스 권한을 얻고 토큰을 새로 고쳐야 합니다.