Asset Compute Service HTTP API asset-compute-http-api

API의 사용은 개발 목적으로 제한됩니다. API는 사용자 정의 애플리케이션을 개발할 때 컨텍스트로 제공됩니다. Adobe Experience Manager as a Cloud Service은(는) API를 사용하여 처리 정보를 사용자 지정 응용 프로그램에 전달합니다. 자세한 내용은 자산 마이크로서비스 및 처리 프로필 사용을 참조하세요.

Asset Compute Service HTTP API의 모든 클라이언트는 다음 높은 수준의 흐름을 따라야 합니다.

adobe-asset-compute-client 모듈을 사용하면 Node.js 코드에서 API를 쉽게 사용할 수 있습니다.

인증 및 권한 부여 authentication-and-authorization

모든 API에는 액세스 토큰 인증이 필요합니다. 요청은 다음 헤더를 설정해야 합니다.

범위 scopes

액세스 토큰에 대해 다음 범위를 확인하십시오.

이 범위를 사용하려면 Adobe Developer Console 프로젝트를 Asset Compute, I/O Events 및 I/O Management API 서비스에 구독해야 합니다. 개별 범위의 분류는 다음과 같습니다.

등록 register

서비스를 구독한 고유한 Adobe Developer Console 프로젝트인 Asset Compute service의 각 클라이언트는 처리 요청을 수행하기 전에 등록해야 합니다. 등록 단계에서는 렌디션 처리에서 비동기 이벤트를 검색하는 데 필요한 고유한 이벤트 저널을 반환합니다.

라이프사이클이 끝나면 클라이언트는 등록 취소할 수 있습니다.

요청 등록 register-request

이 API 호출은 Asset Compute 클라이언트를 설정하고 이벤트 저널 URL을 제공합니다. 이 프로세스는 멱등 연산이며 각 클라이언트에 대해 한 번만 호출하면 됩니다. 저널 URL을 검색하기 위해 다시 호출할 수 있습니다.

응답 등록 register-response

HTTP 상태 코드는 다음과 같습니다.

요청 등록 해제 unregister-request

이 API 호출은 Asset Compute 클라이언트의 등록을 취소합니다. 이 등록 취소가 발생하면 더 이상 /process을(를) 호출할 수 없습니다. 등록되지 않은 클라이언트 또는 아직 등록되지 않은 클라이언트에 대해 API 호출을 사용하면 404 오류가 반환됩니다.

응답 등록 해제 unregister-response

상태 코드는 다음과 같습니다.

요청 처리 process-request

process 작업은 요청의 지침에 따라 소스 에셋을 여러 표현물로 변환하는 작업을 제출합니다. 완료 성공(이벤트 유형 rendition_created) 또는 오류(이벤트 유형 rendition_failed)에 대한 알림이 이벤트 저널로 전송되며, 이벤트 저널은 /process개의 요청을 수행하기 전에 /register을(를) 사용하여 한 번 검색해야 합니다. 형식이 잘못된 요청은 즉시 실패하고 400 오류 코드가 표시됩니다.

바이너리는 Amazon AWS S3 사전 서명된 URL 또는 Azure Blob Storage SAS URL과 같은 URL을 사용하여 참조됩니다. source 자산(GET URL)을 읽고 렌디션(PUT URL)을 쓰는 데 모두 사용됩니다. 클라이언트는 이러한 사전 서명된 URL을 생성할 책임이 있습니다.

프로세스 요청 JSON process-request-json

/process의 요청 본문은 다음과 같은 높은 수준의 스키마를 가진 JSON 개체입니다.

{
    "source": "",
    "renditions" : []
}

사용 가능한 필드는 다음과 같습니다.

source은(는) URL로 보이는 <string>이거나 추가 필드가 있는 <object>일 수 있습니다. 다음 변형은 유사합니다.

"source": "http://example.com/image.jpg"

"source": {
    "url": "http://example.com/image.jpg"
}

Source 개체 필드 source-object-fields

전체 process 요청 예 complete-process-request-example

{
    "source": "https://www.adobe.com/content/dam/acom/en/lobby/lobby-bg-bts2017-logged-out-1440x860.jpg",
    "renditions" : [{
            "name": "image.48x48.png",
            "target": "https://some-presigned-put-url-for-image.48x48.png",
            "fmt": "png",
            "width": 48,
            "height": 48
        },{
            "name": "image.200x200.jpg",
            "target": "https://some-presigned-put-url-for-image.200x200.jpg",
            "fmt": "jpg",
            "width": 200,
            "height": 200
        },{
            "name": "cqdam.xmp.xml",
            "target": "https://some-presigned-put-url-for-cqdam.xmp.xml",
            "fmt": "xmp"
        },{
            "name": "cqdam.text.txt",
            "target": "https://some-presigned-put-url-for-cqdam.text.txt",
            "fmt": "text"
    }]
}

프로세스 응답 process-response

/process 요청은 기본 요청 유효성 검사에 따라 성공 또는 실패로 즉시 반환됩니다. 실제 자산 처리는 비동기적으로 발생합니다.

상태 코드:

대부분의 클라이언트는 401 또는 403과 같은 제외 구성 문제 또는 400과 같은 잘못된 요청에 대해 지수 백오프로 동일한 요청을 다시 시도할 수 있습니다. 429 응답을 통한 일반적인 속도 제한과 별도로, 일시적인 서비스 중단 또는 제한으로 인해 5xx 오류가 발생할 수 있습니다. 그런 다음 일정 시간 후 다시 시도하는 것이 좋습니다.

모든 JSON 응답(있는 경우)에는 X-Request-Id 헤더와 동일한 값인 requestId이(가) 포함됩니다. Adobe 헤더는 항상 존재하므로 헤더에서 읽는 것이 좋습니다. requestId은(는) 처리 요청과 관련된 모든 이벤트에서도 requestId(으)로 반환됩니다. 클라이언트는 이 문자열의 형식을 가정해서는 안 됩니다. 불투명 문자열 식별자입니다.

후 처리 옵트인 opt-in-to-post-processing

Asset compute SDK은(는) 기본 이미지 후처리 옵션 집합을 지원합니다. 사용자 지정 작업자는 렌디션 개체의 postProcess 필드를 true(으)로 설정하여 사후 처리를 명시적으로 옵트인할 수 있습니다.

지원되는 사용 사례는 다음과 같습니다.

자산에 워터마크 추가 add-watermark

Asset compute SDK에서는 PNG, JPEG, TIFF 및 GIF 이미지 파일에 워터마크를 추가할 수 있습니다. 변환의 watermark 개체에 있는 변환 지침에 따라 워터마크가 추가됩니다.

워터마크는 렌디션 후처리 중에 수행됩니다. 에셋에 워터마크를 지정하려면 사용자 지정 작업자 은(는) 렌디션 개체의 필드 postProcess을(를) true(으)로 설정하여 사후 처리를 옵트인합니다. 작업자가 옵트인하지 않으면 워터마크 객체가 요청의 렌디션 객체에 설정되어 있더라도 워터마크가 적용되지 않습니다.

렌디션 지침 rendition-instructions

/process의 renditions 배열에 사용할 수 있는 옵션은 다음과 같습니다.

공통 필드 common-fields

렌디션별 필드 rendition-specific-fields

현재 지원되는 파일 형식 목록은 지원되는 파일 형식을 참조하십시오.

워터마크별 필드 watermark-specific-fields

PNG 형식은 워터마크로 사용됩니다.

비동기 이벤트 asynchronous-events

렌디션 처리가 완료되거나 오류가 발생하면 Adobe I/O Events Journal (으)로 이벤트가 전송됩니다. 클라이언트는 /register을(를) 통해 제공된 저널 URL을 수신해야 합니다. 저널 응답에는 각 이벤트에 대해 하나의 개체로 구성된 event 배열이 포함되며, 그 중 event 필드에는 실제 이벤트 페이로드가 포함됩니다.

Asset Compute Service의 모든 이벤트에 대한 Adobe I/O Events 형식은 asset_compute입니다. 저널은 이 이벤트 유형만 자동으로 구독되며 Adobe Developer 이벤트 유형을 기준으로 필터링할 추가 요구 사항은 없습니다. 서비스별 이벤트 유형은 이벤트의 type 속성에서 사용할 수 있습니다.

이벤트 유형 event-types

이벤트 속성 event-attributes

메타데이터 metadata

오류 이유 error-reasons