웹사이트 버전 배포(Deploy Website) (V2)

준비한 웹사이트 버전을 배포합니다. 본문의 필수 version에 배포할 시맨틱 버전을 지정합니다. 실제 사용자에게 제공할 버전을 바꾸는 작업이므로 대상 앱과 버전을 확인합니다.

자산은 먼저 버전 업로드로 준비합니다. 비동기 자산 또는 취약점 검사가 적용되는 플랫폼 인스턴스에서는 검사가 끝난 뒤 배포합니다. 미리보기와 준비 조건은 호스팅 절차를 따릅니다.

HTTP 요청

POST /api/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy

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

경로 매개변수

쿼리 매개변수

지정할 쿼리 매개변수가 없습니다.

요청 본문

본문 형식은 DeployWebsiteRequest이며 필수입니다.

다음은 배포할 버전을 지정하는 요청 본문 예시입니다.

{
  "version": "1.2.0"
}

응답

응답 형식은 Website입니다.

subdomains의 구조

배열 항목은 Subdomain이며 자료형은 string입니다.

웹사이트를 제공하는 하위 도메인입니다.

배포한 웹사이트의 응답 예시입니다.

{
  "subdomains": [
    "myapp.example.com"
  ],
  "deployedVersion": "1.2.0"
}

개별 오류

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

애플리케이션의 1.2.0을 배포하는 예제입니다. 해당 앱에 준비된 실제 배포 대상 버전을 사용합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/deploy" \
	-d '{"version":"1.2.0"}'

Python

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

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 = {
    "version": "1.2.0"
}

response = requests.post('https://{}/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/deploy'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 DeployWebsiteExample.java 파일에서 사용합니다.

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 DeployWebsiteExample {
    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/deploy");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"version\":\"1.2.0\"}", ContentType.APPLICATION_JSON));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

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

fetch(`https://${HOSTNAME}/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website/deploy`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"version":"1.2.0"}'
}).then((response) => {
    console.log(response)
});

PowerShell

$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/deploy" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"version`":`"1.2.0`"}"

$response.content