Adobe Experience Manager Assets HTTP API assets-http-api

개요 overview

Assets HTTP API를 사용하면 Experience Manager 콘텐츠 조각을 사용하여 구조화된 콘텐츠와 함께 메타데이터, 렌디션 및 댓글을 포함하여 디지털 에셋에서 CRUD(create-read-update-delete) 작업을 수행할 수 있습니다. /api/assets에서 노출되며 REST API로 구현됩니다. 여기에는 콘텐츠 조각 지원이 포함됩니다.

API에 액세스하려면:

API 응답은 일부 MIME 유형에 대한 JSON 파일이며 모든 MIME 유형에 대한 응답 코드입니다. JSON 응답은 선택 사항이며 예를 들어 PDF 파일에 사용하지 못할 수 있습니다. 추가적인 분석 또는 작업을 위해 응답 코드를 사용합니다.

콘텐츠 조각 content-fragments

콘텐츠 조각은(는) 특별한 유형의 자산입니다. 텍스트, 숫자, 날짜 등 구조화된 데이터에 액세스하는 데 사용할 수 있습니다. standard개의 자산(예: 이미지 또는 문서)에 몇 가지 차이점이 있으므로 콘텐츠 조각 처리에 몇 가지 추가 규칙이 적용됩니다.

자세한 내용은 Experience Manager Assets HTTP API🔗에서 콘텐츠 조각 지원을 참조하십시오.

데이터 모델 data-model

Assets HTTP API는 표준 자산의 경우 두 개의 주요 요소, 폴더 및 자산을 노출합니다. 또한 콘텐츠 조각의 구조화된 콘텐츠를 설명하는 사용자 지정 데이터 모델에 대해 보다 자세한 요소를 노출합니다. 자세한 내용은 콘텐츠 조각 데이터 모델을 참조하세요.

폴더 folders

폴더는 기존 파일 시스템에서처럼 디렉토리와 같습니다. 폴더에는 에셋, 폴더 또는 폴더와 에셋만 포함될 수 있습니다. 폴더에는 다음과 같은 구성 요소가 있습니다.

엔터티: 폴더의 엔터티는 폴더 및 에셋일 수 있는 하위 요소입니다.

속성:

링크 폴더에는 세 개의 링크가 있습니다.

자산 assets

Experience Manager에서 자산에 다음 요소가 포함되어 있습니다.

콘텐츠 조각의 요소에 대한 자세한 내용은 Experience Manager Assets HTTP API의 콘텐츠 조각 지원을 참조하십시오.

Experience Manager에서 폴더에 다음 구성 요소가 있습니다.

사용 가능한 기능 available-features

Assets HTTP API에는 다음 기능이 포함되어 있습니다.

폴더 목록 검색 retrieve-a-folder-listing

기존 폴더 및 하위 엔티티(하위 폴더 또는 에셋)의 Siren 표현을 검색합니다.

요청: GET /api/assets/myFolder.json

응답 코드: 응답 코드는 다음과 같습니다.

응답: 반환된 엔터티의 클래스가 에셋 또는 폴더입니다. 포함된 엔티티의 등록 정보는 각 엔티티의 전체 등록 정보 세트의 하위 집합입니다. 엔터티의 전체 표현을 가져오려면 클라이언트는 self의 rel을(를) 가진 링크가 가리키는 URL의 콘텐츠를 검색해야 합니다.

폴더 만들기 create-a-folder

지정된 경로에 sling: OrderedFolder을(를) 만듭니다. *이(가) 노드 이름 대신 제공된 경우 서블릿은 매개 변수 이름을 노드 이름으로 사용합니다. 요청은 다음 중 하나를 수락합니다.

또한 폴더의 속성을 URL 쿼리 매개 변수로 지정할 수 있습니다.

제공된 경로의 부모 노드가 없는 경우 500 응답 코드로 API 호출이 실패합니다. 폴더가 있는 경우 호출에서 응답 코드 409을(를) 반환합니다.

매개 변수: name은(는) 폴더 이름입니다.

요청

응답 코드: 응답 코드는 다음과 같습니다.

에셋 만들기 create-an-asset

에셋을 만드는 방법에 대한 자세한 내용은 에셋 업로드를 참조하십시오. HTTP API를 사용하여 에셋을 만들 수 없습니다.

자산 바이너리 업데이트 update-asset-binary

자산 바이너리를 업데이트하는 방법에 대한 자세한 내용은 자산 업로드를 참조하십시오. HTTP API를 사용하여 자산 바이너리를 업데이트할 수 없습니다.

에셋의 메타데이터 업데이트 update-asset-metadata

자산 메타데이터 속성을 업데이트합니다. dc: 네임스페이스의 속성을 업데이트하는 경우 API는 jcr 네임스페이스의 동일한 속성을 업데이트합니다. API가 두 네임스페이스 아래의 속성을 동기화하지 않습니다.

요청: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"dc:title":"My Asset"}}'

응답 코드: 응답 코드는 다음과 같습니다.

에셋 렌디션 만들기 create-an-asset-rendition

에셋에 대한 렌디션을 만듭니다. 요청 매개변수 이름이 제공되지 않으면 파일 이름이 렌디션 이름으로 사용됩니다.

매개 변수: 매개 변수는 렌디션 이름의 경우 name이고 파일 참조로는 file입니다.

요청

응답 코드

에셋 렌디션 업데이트 update-an-asset-rendition

업데이트는 각각 에셋 렌디션을 새 바이너리 데이터로 바꿉니다.

요청: PUT /api/assets/myfolder/myasset.png/renditions/myRendition.png -H"Content-Type: image/png" --data-binary @myRendition.png

응답 코드: 응답 코드는 다음과 같습니다.

자산에 주석 추가 create-an-asset-comment

매개 변수: 댓글의 메시지 본문에는 매개 변수가 message이고 JSON 형식의 주석 데이터에는 매개 변수가 annotationData입니다.

요청: POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"

응답 코드: 응답 코드는 다음과 같습니다.

폴더 또는 에셋 복사 copy-a-folder-or-asset

제공된 경로에서 사용할 수 있는 폴더 또는 에셋을 새 대상에 복사합니다.

요청 헤더: 매개 변수는 다음과 같습니다.

요청: COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"

응답 코드: 응답 코드는 다음과 같습니다.

폴더 또는 자산 이동 move-a-folder-or-asset

지정된 경로의 폴더 또는 자산을 새 대상으로 이동합니다.

요청 헤더: 매개 변수는 다음과 같습니다.

요청: MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"

응답 코드: 응답 코드는 다음과 같습니다.

폴더, 에셋 또는 렌디션 삭제 delete-a-folder-asset-or-rendition

제공된 경로에서 리소스(-트리)를 삭제합니다.

요청

응답 코드: 응답 코드는 다음과 같습니다.

팁, 모범 사례 및 제한 사항 tips-limitations

추가 참조