호스팅 웹사이트 조회(Get Website) (V2)
타사 애플리케이션의 웹사이트 정보를 조회합니다. Website의 deployedVersion과 subdomains는 선택 필드이며 현재 배포된 버전과 서비스 도메인을 확인할 때 사용합니다.
앱과 도메인을 준비하는 절차는 프런트엔드 호스팅에 있습니다. 조회 요청도 third-party-application:deploy-application-website OAuth 권한 범위를 사용합니다.
HTTP 요청
GET /api/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website
작업 식별자는 v2.getWebsite입니다. OAuth2로 호출하는 타사 애플리케이션에는 third-party-application:deploy-application-website 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.
경로 매개변수
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
thirdPartyApplicationRid | string | 필수 | Developer Console에서 생성한 타사 애플리케이션의 RID입니다. | ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6 |
쿼리 매개변수
지정할 쿼리 매개변수가 없습니다.
요청 본문
요청 본문을 사용하지 않습니다.
응답
응답 형식은 Website입니다.
| 이름 | 자료형 | 필수 여부 | 의미와 조건 | 예시 값 |
|---|---|---|---|---|
deployedVersion | string | 선택 | 현재 배포된 웹사이트 버전입니다. | |
subdomains | list<Subdomain> | 선택 | 현재 웹사이트를 제공하는 하위 도메인 목록입니다. |
subdomains의 구조
배열 항목은 Subdomain이며 자료형은 string입니다.
웹사이트를 제공하는 하위 도메인입니다.
호스팅 웹사이트의 응답 예시입니다.
{
"subdomains": [
"myapp.example.com"
],
"deployedVersion": "1.2.0"
}
개별 오류
| 오류 이름 | 오류 코드 | HTTP | 의미와 조건 | 추가 매개변수 |
|---|---|---|---|---|
WebsiteNotFound | NOT_FOUND | 404 | 웹사이트를 찾을 수 없습니다. | thirdPartyApplicationRid |
요청 예제
FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.
cURL
curl \
-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
"https://${FOUNDRY_HOST}/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website"
Python
Requests 라이브러리가 설치된 Python 환경에서 사용합니다.
import os
import requests
HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
"authorization": "Bearer {}".format(TOKEN)
}
response = requests.get('https://{}/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website'.format(HOSTNAME), headers=headers)
print(response)
Java
Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 GetWebsiteExample.java 파일에서 사용합니다.
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
public class GetWebsiteExample {
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()) {
HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/thirdPartyApplications/ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6/website");
request.addHeader("authorization", String.format("Bearer %s", TOKEN));
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`, {
method: 'GET',
headers: {
'Authorization': `Bearer ${TOKEN}`,
}
}).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" `
-Headers $headers
$response.content