REST API 개요

PlayFab REST API 참조를 시작합니다. 여기에서 참고 자료를 확인하고 API의 작동 방식을 알아볼 수 있습니다. 각 API 참조는 여러 개의 다른 섹션으로 나뉩니다.

엔드포인트

엔드포인트는 API 요청을 할 수 있는 HTTP URL입니다. 앞에는 REST 메서드 형식(예: GET, POST)이 있습니다. 또한 titleId는 실제 게임 titleId로 바꾸어야 합니다.

예:

POST https://[titleId].playfabapi.com/Client/LoginWithCustomID

요청 본문

요청 본문은 (JSON) 형식으로 API 서비스에 전송된 개체 모델입니다. 이러한 모델에는 API와 함께 페이로드로 전송되어야 하는 속성이 포함됩니다. 일부 속성은 필수로 표시되고, 또 다른 일부 속성은 선택 사항입니다.

응답

API 서비스는 모델로 역직렬화될 수 있는 JSON 페이로드와 함께 200 OK를 반환합니다. 아래 예제에서 로그인 API는 LoginResult 유형으로의 역직렬화를 호출합니다.

응답이 실패하면 4XX 오류 응답이 수신됩니다. 400 잘못된 요청은 API 호출에서 매개 변수가 누락되거나 속도 제한 및 유효성 검사 오류와 같은 기타 이유로 인해 발생할 수 있습니다. 4XX 오류가 발생하는 경우 요청 매개 변수 및 인증 토큰을 검사 올바른지 확인하는 것이 가장 좋습니다. ApiErrorWrapper 개체에는 오류를 식별하는 데 도움이 되는 오류 코드, 오류 세부 정보 및 서버의 오류 메시지를 포함하여 오류에 대한 중요한 정보가 포함되어 있습니다.

보안

각 API에는 각 요청의 헤더에 전달되어야 하는 보안 형식이 있습니다. 정의되어야 하는 사항을 알아보려면 이 섹션을 참조하세요. 경우에 따라 로그인 요청의 세션 티켓이거나 서버 API 요청을 만드는 경우 타이틀 비밀 키일 수 있습니다.

동시성

API 서비스는 각 타이틀에서 매우 많은 수의 동시 호출을 처리하도록 설계되었지만 단일 플레이어 또는 다른 단일 엔터티(예: 문자 또는 그룹)에 액세스할 수 있는 동시 호출 수에는 제한 사항이 있습니다. 이 동시성 제한을 초과하면 API는 APIConcurrentRequestLimitExceeded 또는 ConcurrentEditError 오류 코드를 반환합니다. 일반적으로 지정된 플레이어에 대해 두 개 이상의 읽기 요청을 동시에 만드는 것은 안전하지만 한 번에 하나의 업데이트 요청을 만드는 것이 가장 좋습니다.

모델 정의

API 서비스의 각 응답에는 하나 이상의 모델이 포함될 수 있습니다. ApiErrorWrapper 아래에 위치하며 각 모델은 API와 동일한 문서에 표시됩니다. 각 모델은 또한 응답 상위 모델과 연결됩니다. 또한 각 API 페이지의 정의 섹션에서 API에서 지원되는 모델 목록을 확인할 수 있습니다.

이벤트 모델 정의

PlayStream 이벤트 모델 참조에는 자동으로 생성된 PlayStream 이벤트 유형의 모델이 포함되어 있습니다. 각 이벤트 유형에는 어디에서 전송되는지와 무관하게 이벤트 데이터의 일부분으로 포함되는 속성 집합이 있습니다.