미디어 변환 시작(Transform Media Item) (V2)

미디어 항목의 변환 작업을 시작하고 jobId를 받습니다. 상태 조회로 성공을 확인한 뒤 결과를 내려받습니다.

변환할 항목을 읽을 수 있어야 합니다. api:mediasets-read 권한 범위 또는 MediaItemReadToken으로 읽기 접근을 확보하고 변환 권한 범위인 api:mediasets-transform도 준비합니다. 읽기 토큰을 전달할 때는 선택 헤더 Token을 사용합니다. 선택 헤더 Attribution은 사용량 귀속 문자열을 받습니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

POST /api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform

작업 식별자는 v2.transformMediaItem입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:mediasets-transform 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

쿼리 매개변수

요청 본문

필수 TransformMediaItemRequest 본문의 transformation에 변환 종류와 그 매개변수를 지정합니다.

transformation의 구조

선택 가능한 18가지 type과 전체 필드는 변환 선택에서 확인합니다. 한 분기를 선택하고 해당 분기의 필수 매개변수를 전달합니다.

다음 본문의 식별자와 값은 가상 예시입니다.

{
  "transformation": {
    "type": "image",
    "encoding": {
      "type": "webp"
    },
    "operations": [
      {
        "type": "resize",
        "width": 800,
        "height": 600
      }
    ]
  }
}

응답

응답 형식은 TransformMediaItemResponse입니다.

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 제공합니다.

환경 변수 MEDIA_SET_RID, MEDIA_ITEM_RID에 실제 요청 대상의 식별자를 제공합니다.

800×600 크기의 WebP를 요청하는 이미지 예제입니다. api:mediasets-read와 api:mediasets-transform을 갖춘 토큰으로 호출하는 구성이며, 읽기 토큰을 사용하는 경우에는 해당 MediaItemReadToken을 Token 헤더에 추가합니다. 실제 이미지 항목과 필요한 출력 설정을 사용합니다.

cURL

curl --fail -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/mediasets/${MEDIA_SET_RID}/items/${MEDIA_ITEM_RID}/transform?preview=true" \
	-d '{"transformation":{"type":"image","encoding":{"type":"webp"},"operations":[{"type":"resize","width":800,"height":600}]}}'

Python

Requests 라이브러리가 설치된 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "transformation": {
        "type": "image",
        "encoding": {
            "type": "webp"
        },
        "operations": [
            {
                "type": "resize",
                "width": 800,
                "height": 600
            }
        ]
    }
}

response = requests.post('https://{}/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform?preview=true'.format(HOSTNAME, mediaSetRid=os.environ["MEDIA_SET_RID"], mediaItemRid=os.environ["MEDIA_ITEM_RID"]), headers=headers, json=request_body)
response.raise_for_status()
print(response.json())

Java

Apache HttpClient 4.5 API를 사용하는 TransformMediaItemExample.java 예제입니다.

import java.io.IOException;
import org.apache.http.util.EntityUtils;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class TransformMediaItemExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/mediasets/" + System.getenv("MEDIA_SET_RID") + "/items/" + System.getenv("MEDIA_ITEM_RID") + "/transform?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"transformation\":{\"type\":\"image\",\"encoding\":{\"type\":\"webp\"},\"operations\":[{\"type\":\"resize\",\"width\":800,\"height\":600}]}}", ContentType.APPLICATION_JSON));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                int status = response.getStatusLine().getStatusCode();
                if (status < 200 || status >= 300) throw new IOException("HTTP " + status);
                System.out.println(EntityUtils.toString(response.getEntity(), "UTF-8"));
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. import가 있는 예제는 ES 모듈(.mjs)로 실행합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/mediasets/${process.env.MEDIA_SET_RID}/items/${process.env.MEDIA_ITEM_RID}/transform?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"transformation":{"type":"image","encoding":{"type":"webp"},"operations":[{"type":"resize","width":800,"height":600}]}}'
}).then(async (response) => {
    if (!response.ok) {
        await response.body?.cancel();
        throw new Error(`HTTP ${response.status}`);
    }
    console.log(await response.json())
});

PowerShell

스크립트 오류가 발생하면 중단하도록 ErrorActionPreference를 설정합니다.

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/mediasets/${env:MEDIA_SET_RID}/items/${env:MEDIA_ITEM_RID}/transform?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"transformation`":{`"type`":`"image`",`"encoding`":{`"type`":`"webp`"},`"operations`":[{`"type`":`"resize`",`"width`":800,`"height`":600}]}}"

$response.content