AEM Assets HTTP API의 컨텐츠 조각 지원

개요

AEM 헤드리스 게재 기능의 중요한 부분인 Assets HTTP API의 컨텐츠 조각에 대한 지원에 대해 알아봅니다.

노트

Assets HTTP API는 다음을 포함합니다.

  • 자산 REST API
  • 컨텐츠 조각에 대한 지원 포함

Assets HTTP API의 현재 구현은 REST 아키텍처 스타일을 기반으로 합니다.

Assets REST API를 사용하면 Adobe Experience Manager 개발자를 Cloud Service으로 사용하여 CRUD 작업(만들기, 읽기, 업데이트, 삭제)을 통해 HTTP API를 통해 직접 컨텐츠(AEM에 저장됨)에 액세스할 수 있습니다.

API를 사용하면 JavaScript 프런트 엔드 애플리케이션에 컨텐츠 서비스를 제공하여 Adobe Experience Manager을 헤드리스 CMS(Content Management System)로 Cloud Service으로 운영할 수 있습니다. 또는 HTTP 요청을 실행하고 JSON 응답을 처리할 수 있는 다른 애플리케이션입니다.

예를 들어, 단일 페이지 애플리케이션(SPA), 프레임워크 기반 또는 사용자 지정에서는 HTTP API를 통해 제공되는 컨텐츠(종종 JSON 형식)가 필요합니다.

AEM 코어 구성 요소는 이 목적에 필요한 읽기 작업을 제공할 수 있고 JSON 출력을 사용자 지정할 수 있는 매우 포괄적이고 유연한 사용자 지정 가능한 API를 제공하지만, 전용 AEM 템플릿을 기반으로 하는 페이지에서 호스팅해야 하므로 AEM WCM(Web Content Management) 구현에 대한 노하우가 필요합니다. 모든 SPA 개발 조직이 이러한 지식을 직접 액세스하는 것은 아닙니다.

이때 Assets REST API를 사용할 수 있습니다. 이를 통해 개발자는 페이지에 먼저 포함할 필요 없이 자산(예: 이미지 및 컨텐츠 조각)에 직접 액세스하여 직렬화된 JSON 형식으로 콘텐츠를 제공할 수 있습니다.

노트

Assets REST API에서 JSON 출력을 사용자 지정할 수 없습니다.

Assets REST API를 사용하면 기존 자산, 컨텐츠 조각 및 폴더를 새로 만들거나, 업데이트하거나, 삭제하여 컨텐츠를 수정할 수 있습니다.

자산 REST API:

전제 조건

Assets REST API는 최신 Adobe Experience Manager as a Cloud Service 버전으로 즉시 설치할 때마다 사용할 수 있습니다.

주요 개념

Assets REST API는 AEM 인스턴스 내에 저장된 자산에 대한 REST 스타일 액세스를 제공합니다.

이 플러그인은 /api/assets 종단점을 사용하고 선행 /content/dam 없이 자산에 액세스할 자산의 경로가 필요합니다.

  • 즉, 다음 위치에서 자산에 액세스합니다.
    • /content/dam/path/to/asset
  • 다음을 요청해야 합니다.
    • /api/assets/path/to/asset

예를 들어 /content/dam/wknd/en/adventures/cycling-tuscany에 액세스하려면 /api/assets/wknd/en/adventures/cycling-tuscany.json을 요청합니다

노트

액세스 권한:

  • /api/assets 선택기를 사용할 필요가 .model 없습니다.
  • /content/path/to/page ​를 사용하려면 선택기를 사용해야 .model 합니다.

HTTP 메서드는 실행할 작업을 결정합니다.

  • GET - 자산 또는 폴더의 JSON 표현을 검색합니다
  • POST - 새 자산 또는 폴더를 만들려면
  • PUT - 자산 또는 폴더의 속성을 업데이트하는 방법
  • DELETE - 자산 또는 폴더를 삭제하려면
노트

요청 본문 및/또는 URL 매개 변수를 사용하여 이러한 작업 중 일부를 구성할 수 있습니다. 예를 들어, POST 요청으로 폴더나 자산을 만들어야 함을 정의합니다.

지원되는 요청의 정확한 형식은 API 참조 설명서에서 정의됩니다.

트랜잭션 동작

모든 요청은 원자입니다.

즉, 후속(write) 요청을 단일 엔티티로 성공하거나 실패할 수 있는 단일 트랜잭션으로 결합할 수 없습니다.

AEM(Assets) REST API와 AEM 구성 요소

Aspect 자산 REST API
AEM 구성 요소
(Sling 모델을 사용하는 구성 요소)
지원되는 사용 사례 일반적인 목적.

단일 페이지 애플리케이션(SPA) 또는 기타(컨텐츠 소비) 컨텍스트에서 소비에 최적화되었습니다.

레이아웃 정보를 포함할 수도 있습니다.

지원되는 작업

작성, 읽기, 업데이트, 삭제

엔티티 유형에 따라 추가 작업이 제공됩니다.

읽기 전용.
액세스

직접 액세스할 수 있습니다.

/content/dam에 매핑된 /api/assets 끝점을 사용합니다(저장소에서).

예제 경로는 다음과 같습니다. /api/assets/wknd/en/adventures/cycling-tuscany.json

AEM 페이지에서 AEM 구성 요소를 통해 참조되어야 합니다.

.model 선택기를 사용하여 JSON 표현을 만듭니다.

예제 경로는 다음과 같습니다.
/content/wknd/language-masters/en/adventures/cycling-tuscany.model.json

보안

여러 옵션이 가능합니다.

OAuth가 제안됩니다. 표준 설정과 별도로 구성할 수 있습니다.

AEM 표준 설정을 사용합니다.
건축주의

쓰기 액세스는 일반적으로 작성자 인스턴스의 주소를 지정합니다.

읽기가 게시 인스턴스로 보내질 수도 있습니다.

이 방법은 읽기 전용이므로 일반적으로 게시 인스턴스에 사용됩니다.
출력 JSON 기반 SHANNER 출력: 장황하지만 강력해 컨텐츠 내에서 탐색할 수 있습니다. JSON 기반 독점 출력; Sling 모델을 통해 구성할 수 있습니다. 컨텐츠 구조를 탐색하는 것은 구현하기가 어렵습니다(하지만 반드시 불가능한 것은 아님).

보안

특정 인증 요구 사항 없이 환경 내에서 Assets REST API를 사용하는 경우 AEM CORS 필터를 올바르게 구성해야 합니다.

노트

자세한 내용은 다음을 참조하십시오.

특정 인증 요구 사항이 있는 환경에서는 OAuth가 권장됩니다.

사용 가능한 기능

컨텐츠 조각은 특정 유형의 자산입니다. 컨텐츠 조각으로 작업을 참조하십시오.

API를 통해 사용할 수 있는 기능에 대한 자세한 내용은 다음을 참조하십시오.

페이징

Assets REST API는 URL 매개 변수를 통해 페이징(GET 요청)을 지원합니다.

  • offset - 검색할 첫 번째(하위) 엔티티의 수
  • limit - 반환된 최대 개체 수

응답에는 SEARM 출력의 properties 섹션의 일부로 페이징 정보가 포함됩니다. 이 srn:paging 속성은 요청에 지정된 총 (자식) 엔터티( total), 오프셋 및 제한( offset, limit)을 포함합니다.

노트

페이징은 일반적으로 요청된 엔티티의 1차 하위 구성요소와 관련된 컨테이너 엔티티(즉, 폴더 또는 변환이 있는 자산)에 적용됩니다.

예: 페이징

GET /api/assets.json?offset=2&limit=3

...
"properties": {
    ...
    "srn:paging": {
        "total": 7,
        "offset": 2,
        "limit": 3
    }
    ...
}
...

엔티티 유형

폴더

폴더는 자산 및 기타 폴더에 대한 컨테이너 역할을 합니다. AEM 컨텐츠 저장소의 구조를 반영합니다.

Assets REST API는 폴더의 속성에 대한 액세스 권한을 노출합니다. 예를 들어 해당 이름, 제목 등이 있습니다. 자산은 폴더 및 하위 폴더의 하위 엔티티로 노출됩니다.

노트

하위 자산 및 폴더의 자산 유형에 따라 하위 엔티티 목록에 이미 각 하위 엔티티를 정의하는 전체 속성 세트가 포함될 수 있습니다. 또는 이 자식 엔티티 목록에서 엔티티에 대해 축소된 속성 집합만 노출될 수 있습니다.

에셋

자산이 요청되면 응답은 해당 메타데이터를 반환합니다. 제목, 이름 및 각 자산 스키마에 의해 정의된 기타 정보와 같은 정보를 제공합니다.

자산의 바이너리 데이터는 content 유형의 SYNAM 링크로 표시됩니다.

자산에는 여러 표현물이 있을 수 있습니다. 이러한 항목은 일반적으로 하위 엔티티로 노출되며 한 가지 예외는 축소판 표현이며 thumbnail 유형의 링크로 표시됩니다( rel="thumbnail").

콘텐츠 조각

컨텐츠 조각은 특별한 유형의 자산입니다. 텍스트, 숫자, 날짜 등과 같은 구조화된 데이터에 액세스하는 데 사용할 수 있습니다.

표준 자산(이미지 또는 오디오 등)에 몇 가지 차이점이 있으므로 일부 추가 규칙이 이러한 자산을 처리하는 데 적용됩니다.

표시

컨텐츠 조각:

  • 이진 데이터는 노출하지 마십시오.

  • 는 JSON 출력(properties 속성 내)에 완전히 포함되어 있습니다.

  • 또한 원자로도 간주됩니다. 즉, 요소 및 변형이 조각의 속성의 일부와 링크 또는 하위 엔티티의 일부로 노출됩니다. 이를 통해 조각의 페이로드에 효율적으로 액세스할 수 있습니다.

컨텐츠 모델 및 컨텐츠 조각

현재 컨텐츠 조각의 구조를 정의하는 모델은 HTTP API를 통해 노출되지 않습니다. 따라서 대부분의 정보를 페이로드에서 유추할 수 있지만 소비자​는 조각의 모델에 대해 알아야 합니다(최소). 데이터 유형 등 는 정의의 일부입니다.

새 컨텐츠 조각을 생성하려면 모델의 (내부 저장소) 경로를 제공해야 합니다.

관련 컨텐츠

연관된 컨텐츠는 현재 노출되지 않습니다.

사용

사용법은 특정 사용 사례와 함께 AEM 작성자 또는 게시 환경을 사용하는지에 따라 다를 수 있습니다.

  • 만들기가 작성자 인스턴스(에 바인딩되어 있고, 현재 이 API)를 사용하여 게시할 조각을 복제할 방법이 없습니다.

  • AEM은 요청된 컨텐츠를 JSON 형식으로만 제공하므로 두 방법 모두에서 게재가 가능합니다.

    • AEM 작성자 인스턴스에서 저장 및 전달하면 방화벽 뒤에서 미디어 라이브러리 응용 프로그램이 충분해야 합니다.

    • 라이브 웹 전달을 위해 AEM 게시 인스턴스가 권장됩니다.

주의

AEM 클라우드 인스턴스의 Dispatcher 구성은 /api에 대한 액세스를 차단할 수 있습니다.

노트

자세한 내용은 API 참조를 참조하십시오. 특히 Adobe Experience Manager Assets API - 컨텐츠 조각.

읽기/전달

사용 방법:

GET /{cfParentPath}/{cfName}.json

예:

http://<host>/api/assets/wknd/en/adventures/cycling-tuscany.json

응답은 컨텐츠 조각에서와 같이 구조화된 컨텐츠와 함께 일련화된 JSON입니다. 참조는 참조 URL로 전달됩니다.

두 가지 유형의 읽기 작업이 가능합니다.

  • 특정 컨텐츠 조각을 경로별로 읽으면 컨텐츠 조각의 JSON 표현이 반환됩니다.
  • 경로별 컨텐츠 조각 폴더 읽기: 이렇게 하면 폴더 내에 있는 모든 컨텐츠 조각의 JSON 표현이 반환됩니다.

만들기

사용 방법:

POST /{cfParentPath}/{cfName}

본문에는 컨텐츠 조각 요소에서 설정해야 하는 초기 컨텐츠를 포함하여 만들 컨텐츠 조각의 JSON 표현이 포함되어 있어야 합니다. cq:model 속성을 설정해야 하며 유효한 컨텐츠 조각 모델을 가리켜야 합니다. 실패하면 오류가 발생합니다. application/json 로 설정된 헤더 Content-Type을 추가해야 합니다.

업데이트

사용 방법

PUT /{cfParentPath}/{cfName}

본문에는 주어진 컨텐츠 조각에 대해 업데이트할 사항에 대한 JSON 표현이 포함되어 있어야 합니다.

컨텐츠 조각, 단일 요소 또는 모든 요소 값 및/또는 메타데이터의 제목 또는 설명일 수 있습니다.

삭제

사용 방법:

DELETE /{cfParentPath}/{cfName}

제한 사항

다음과 같은 몇 가지 제한 사항이 있습니다.

  • 컨텐츠 조각 모델은 현재 지원되지 않습니다. 읽거나 만들 수 없습니다. 신규 컨텐츠 조각을 생성하거나 기존 컨텐츠 조각을 업데이트하려면 개발자가 컨텐츠 조각 모델에 대한 올바른 경로를 알아야 합니다. 현재 이러한 UI에 대한 개요를 얻는 유일한 방법은 관리 UI를 사용하는 것입니다.
  • 참조는 무시됩니다. 현재 기존 컨텐츠 조각을 참조하는지 여부에 대한 검사가 없습니다. 따라서, 예를 들어 컨텐츠 조각을 삭제하면 삭제된 컨텐츠 조각에 대한 참조가 포함된 페이지에 문제가 발생할 수 있습니다.
  • JSON 데이터 유형JSON 데이터 유형의 REST API 출력은 현재 문자열 기반 출력입니다.

상태 코드 및 오류 메시지

관련 상황에서는 다음 상태 코드를 볼 수 있습니다.

  • 다음 경우에 200 (확인)이 반환됩니다.

    • GET을 통해 컨텐츠 조각 요청
    • PUT을(를) 통해 컨텐츠 조각을 업데이트했습니다.
  • 다음 경우에 201(생성됨)이 반환됩니다.

    • POST을(를) 통해 컨텐츠 조각을 성공적으로 생성
  • 404 (찾을 수 없음) 다음 경우에 반환됩니다.

    • 요청된 컨텐츠 조각이 없습니다.
  • 500 (내부 서버 오류)

    노트

    이 오류가 반환됩니다.

    • 특정 코드로 식별할 수 없는 오류가 발생한 경우
    • 지정된 페이로드가 올바르지 않은 경우

    다음은 이 오류 상태가 반환될 때 발생하는 일반적인 시나리오와 생성된 오류 메시지(모노스페이스)를 나열합니다.

    • 상위 폴더가 없습니다( POST 을 통해 컨텐츠 조각을 만들 때).

    • 제공된 컨텐츠 조각 모델이 없습니다(cq:model이 없음). 읽을 수 없거나(잘못된 경로 또는 권한 문제로 인해) 올바른 조각 모델이 없습니다.

      • No content fragment model specified
      • Cannot create a resource of given model '/foo/bar/qux'
    • 컨텐츠 조각을 만들 수 없습니다(권한 문제일 수 있음).

      • Could not create content fragment
    • 제목 및 또는 설명을 업데이트할 수 없습니다.

      • Could not set value on content fragment
    • 메타데이터를 설정할 수 없습니다.

      • Could not set metadata on content fragment
    • 콘텐츠 요소를 찾을 수 없거나 업데이트할 수 없습니다.

      • Could not update content element
      • Could not update fragment data of element

    자세한 오류 메시지는 일반적으로 다음 방식으로 반환됩니다.

    {
      "class": "core/response",
      "properties": {
        "path": "/api/assets/foo/bar/qux",
        "location": "/api/assets/foo/bar/qux.json",
        "parentLocation": "/api/assets/foo/bar.json",
        "status.code": 500,
        "status.message": "...{error message}.."
      }
    }
    

API 참조

자세한 API 참조는 다음을 참조하십시오.

추가 리소스

자세한 내용은 다음을 참조하십시오.

이 페이지에서는