웹사이트 ZIP 버전 업로드(Upload Version) (V2)

웹사이트의 새 버전을 업로드합니다. 필수 쿼리 매개변수 version으로 시맨틱 버전을 지정하고 요청 본문으로 ZIP 바이트를 전송합니다.

정적 HTML, CSS, JavaScript와 자산을 준비합니다. 프로덕션 빌드 폴더의 내용물을 ZIP 루트에 넣으며 폴더 자체를 한 단계 더 감싸지 않습니다. 최대 파일 수는 1,000개, 총 업로드 크기는 20 MB입니다. 서버 측 코드 실행은 지원하지 않습니다.

업로드한 버전의 운영 배포는 Deploy Website로 수행합니다. 도메인과 앱 유형 및 비동기 검사 조건은 호스팅 설정을 따릅니다.

HTTP 요청

POST /api/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload

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

경로 매개변수

쿼리 매개변수

요청 본문

본문은 ZIP 파일의 바이너리이며 Content-Type: application/octet-stream으로 전송합니다. ZIP을 JSON이나 multipart 폼으로 감싸지 않습니다. 애플리케이션의 정적 자산을 담은 ZIP 파일입니다. 디렉터리의 내용물을 묶는 방법과 호스팅 조건은 프런트엔드 호스팅을 따릅니다.

응답

응답 형식은 Version입니다.

업로드한 웹사이트 버전의 응답 예시입니다.

{
  "version": "1.2.0"
}

개별 오류

요청 예제

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

예제의 애플리케이션 RID와 version=1.2.0을 실제 업로드 대상 및 버전으로 바꿉니다.

WEBSITE_ZIP_FILE은 업로드할 로컬 파일의 경로입니다. 파일 내용을 바이너리로 전송합니다. JavaScript 예제는 스트림 요청 본문을 지원하는 Node.js에서 ES 모듈(.mjs)로 실행합니다.

cURL

curl --fail -X POST \
	-H "Content-type: application/octet-stream" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/versions/upload?version=1.2.0" \
	--data-binary "@${WEBSITE_ZIP_FILE}"

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/octet-stream",
    "authorization": "Bearer {}".format(TOKEN)
}

with open(os.environ["WEBSITE_ZIP_FILE"], "rb") as media_file:
    with requests.post('https://{}/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/versions/upload?version=1.2.0'.format(HOSTNAME), headers=headers, data=media_file) as response:
        response.raise_for_status()
        print(response.json())

Java

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

import java.io.File;
import java.io.IOException;
import org.apache.http.entity.FileEntity;
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;

public class UploadVersionExample {
    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/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/versions/upload?version=1.2.0");
            request.addHeader("content-type", "application/octet-stream");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new FileEntity(new File(System.getenv("WEBSITE_ZIP_FILE"))));
            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)로 실행합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

import { createReadStream } from "node:fs";

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

const mediaFile = createReadStream(process.env.WEBSITE_ZIP_FILE);
try {
    const response = await fetch(`https://${HOSTNAME}/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/versions/upload?version=1.2.0`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/octet-stream',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: mediaFile,
    duplex: 'half'
});
    if (!response.ok) {
        await response.body?.cancel();
        throw new Error(`HTTP ${response.status}`);
    }
    console.log(await response.json());
} finally {
    mediaFile.destroy();
}

PowerShell

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

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

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/versions/upload?version=1.2.0" `
	-Method Post `
	-Headers $headers `
	-ContentType application/octet-stream `
	-InFile $env:WEBSITE_ZIP_FILE

$response.content