CloudScript에서 Webhook 호출 - XBOX Game Development Documentation

CloudScript의 잘 알려지지 않은 기능 중 하나는 표준 REST(Representational State Transfer) 호출을 사용하여 모든 웹 API 엔드포인트에 대해 Webhook 호출을 할 수 있다는 것입니다.

가능하면 최신 CloudScript Functions를 사용하여 Webhook 호출을 하는 것을 권장합니다.

이를 통해 타이틀은 기본 정보 서비스에 호출할 수 있을 뿐만 아니라, OAuth 사용과 같은 더 복잡한 시나리오를 통해 사용자가 소유한 엔드포인트에 대한 통신을 보호할 수도 있습니다. 이 자습서에서는 비보안 및 보안 시나리오 모두에 대해 CloudScript에서 Webhook을 호출하는 방법에 대해 설명합니다.

아웃바운드 CloudScript 호출에 사용되는 IP 주소를 허용 목록에 추가해야 하는 경우, 개발자 포털의 API Features 페이지의 ‘PlayFab static IP prefixes and addresses’ 섹션을 참조할 수 있습니다.

REST 호출로서, CloudScript에서의 Webhook 호출 구조는 간단합니다. 지정해야 할 요소는 다음과 같습니다.

URL 엔드포인트.
REST 메서드(post, get, put 또는 delete).
필요한 헤더.
콘텐츠 유형(가장 일반적으로 application/JSON).
콘텐츠 자체(본문).

예를 들어, 서버 측 로직의 버전 번호를 가져오는 기본 웹 API 호출은 아래 예제와 유사할 수 있습니다.

// CloudScript
var url = "http://api.yoursite.com/playfab_call/GetVersion";
var method = "post";
var contentBody = "";
var contentType = "application/json";
var headers = {};
var responseString =  http.request(url,method,contentBody,contentType,headers);

응답 본문은 문자열화된 형태로 반환되므로, 스크립트의 나머지 부분에서 계속 사용할 수 있습니다. 이 경우, 버전을 쿼리했으므로, 여기에 제공된 것처럼 응답을 log에 기록할 수 있습니다.

// CloudScript
log.info(responseString);

CloudScript 실행이 끝난 후 클라이언트에게 돌아가는 응답은 아래 예제와 같을 수 있습니다.

//HTTP Response
{
    "code": 200,
    "status": "OK",
    "data":
    {
        "FunctionName": "MyScript",
        "Revision": 23,
        "FunctionResult": true,
        "Logs": [
        {
            "Level": "Info",
            "Message": "{\"version\": 3}"
        }],
        "ExecutionTimeSeconds": 0.4309841,
        "MemoryConsumedBytes": 29608,
        "APIRequestsIssued": 0,
        "HttpRequestsIssued": 1
    }
}

그러나 통신해야 하는 보안 서비스가 있다면, 먼저 해당 서비스와 자격 증명을 교환하여 신원을 확립해야 합니다. OAuth 솔루션의 경우, 이는 클라이언트 ID와 비밀을 사용하여 Bearer Access 토큰을 요청하는 것을 의미합니다. 이는 특정 OAuth 구현에 따라 다르지만, 호출은 다음 예제와 유사할 수 있습니다.

//CloudScript
var url = "https://api.yoursite.com/playfab_call/request_token";
var method = "post";
var contentBody = "grant_type=client_credentials";
var contentType = "application/x-www-form-urlencoded";
var headers = {};
headers["client_id"] = clientId;
headers["client_secret"] = clientSecret;

var tokenResponse =  http.request(url,method,contentBody,contentType,headers);

좋은 응답을 받았다면, 다음과 같이 응답에서 bearer_access_token을 파싱할 수 있습니다(다시 말하지만, 이는 OAuth 구현의 세부 사항에 따라 다르지만, 이러한 형태의 인증에 대한 상당히 일반적인 패턴입니다).

//CloudScript
var parsedData = JSON.parse(tokenResponse);
var bearer_access_token = parsedData["access_token"];

그러면 bearer_access_token을 제공하여 OAuth로 보호되는 기능을 호출할 수 있습니다.

//CloudScript
var url = "https://api.yoursite.com/playfab_call/do_action";
var method = "post";
var contentBody = customActionBody;
var contentType = "application/json";
var headers = {};
headers["authorization"] = "Bearer " + bearer_access_token;

따라서 이 경우의 기본 패턴은 호출을 위한 고유한 Bearer Access 토큰을 얻기 위해 애플리케이션의 클라이언트 ID와 비밀을 사용한 다음, 이를 사용하여 해당 호출을 보호하는 것입니다. 보시다시피, 이러한 호출은 모두 중간자 공격을 방지하는 데 도움이 되도록 SSL을 사용하여 이루어집니다. CloudScript에서 HTTP 호출을 사용하면, 타이틀에 필요한 다른 웹 API에 호출할 수 있습니다. 이를 통해 PlayFab이 직접 제공하는 것 이상으로 타이틀 기능을 확장할 수 있으며, 자체 사용자 지정 서비스를 만들고 사용하거나 다른 서비스에 액세스할 수 있는 옵션을 제공합니다. 이 모든 것이 CloudScript 내에서 이루어지므로, 이러한 호출을 하기 위한 서버 권한 컨텍스트를 제공합니다. 즉, 플레이어가 부정 행위를 하거나 접근해서는 안 되는 기능 및 데이터에 액세스하는 것을 방지하는 데 도움이 되는 필요한 보호 기능을 CloudScript에서 갖게 됩니다.