> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PlayFab REST API 참조 개요

> 엔드포인트, 요청 및 응답 형식, 인증, 각 API 섹션의 구성 방식을 포함한 PlayFab REST API 참조 개요입니다.

# REST API 개요

PlayFab REST API 참조에 오신 것을 환영합니다. 여기에서 참조 자료를 확인하고 API 동작 방식에 대한 인사이트를 얻을 수 있습니다. 각 API 참조는 여러 섹션으로 나뉘어 있습니다.

## Endpoint

엔드포인트는 API 요청을 보낼 수 있는 HTTP URL입니다. 이 URL 앞에는 REST 메서드 유형(예: GET, POST)이 붙습니다. 또한 titleId는 게임의 titleId로 대체되어야 합니다.

예시:

```html theme={null}
POST https://[titleId].playfabapi.com/Client/LoginWithCustomID
```

## 요청 본문

요청 본문은 API 서비스로 (JSON) 형식으로 전송되는 객체 모델입니다. 이 모델에는 API 호출 시 페이로드로 함께 전송해야 하는 속성이 들어 있습니다. 일부 속성은 **필수**로 표시되며, 나머지는 **선택** 사항입니다.

## 응답

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

<img src="https://mintcdn.com/microsoft-4404708b/5IpvKlT-jmAaVkeY/images/playfab/api-references/images/responses.png?fit=max&auto=format&n=5IpvKlT-jmAaVkeY&q=85&s=363a07961f6ae8fe4348456adeca6fca" alt="LoginResult가 포함된 200 OK 응답 예시" width="1006" height="230" data-path="images/playfab/api-references/images/responses.png" />

응답이 실패하면 4XX 오류 응답이 반환됩니다. 400 Bad Request는 API 호출에 필요한 매개변수가 누락되었거나, 속도 제한을 초과했거나, 유효성 검사 오류 등의 이유로 자주 발생할 수 있습니다. 4XX 오류가 발생한다면 요청 매개변수와 인증 토큰이 올바른지 확인하는 것이 가장 좋습니다. ApiErrorWrapper 객체에는 오류 코드, 오류 세부 정보, 서버에서 반환한 오류 메시지 등 문제를 식별하는 데 도움이 되는 유용한 정보가 담겨 있습니다.

## 보안

각 API는 요청 헤더에 전달해야 하는 일종의 보안 정보를 요구합니다. 이 섹션을 참고하여 무엇을 정의해야 하는지 확인하세요. 로그인 요청의 세션 티켓일 수도 있고, 서버 API 요청을 보내는 경우에는 타이틀 시크릿 키가 될 수도 있습니다.

## 동시성

API 서비스는 각 타이틀에서 매우 많은 수의 동시 호출을 처리하도록 설계되었지만, 단일 플레이어 또는 캐릭터나 그룹 같은 단일 엔티티에 대해 동시에 접근할 수 있는 호출 수에는 제한과 제약이 있습니다. 이 동시성 한도를 초과하면 API는 `APIConcurrentRequestLimitExceeded` 또는 `ConcurrentEditError` 오류 코드를 반환합니다. 일반적으로 특정 플레이어에 대해 여러 개의 읽기 요청을 동시에 보내는 것은 안전하지만, 업데이트 요청은 한 번에 하나씩 보내는 것이 가장 좋습니다.

## 모델 정의

API 서비스의 각 응답에는 하나 이상의 모델이 포함될 수 있습니다. 이러한 모델은 ApiErrorWrapper 아래에 위치하며, 각 모델은 API와 동일한 문서에 표시됩니다. 또한 각 모델은 응답 부모 모델에서 링크됩니다. 각 API 페이지의 Definitions 섹션을 방문하면 해당 API가 지원하는 모델 목록도 확인할 수 있습니다.

### 이벤트 모델 정의

[PlayStream 이벤트 모델 참조](/services/playfab/api-references/events)에는 자동으로 생성된 PlayStream 이벤트 유형의 모델이 포함되어 있습니다. 각 이벤트 유형에는 이벤트 데이터의 일부로 어디로 전송되든 함께 포함되는 속성 집합이 있습니다.


## Related topics

- [PlayFab Lobby 개요](/ko/services/playfab/multiplayer/lobby/index.md)
- [빌드 별칭 관리 및 할당](/ko/services/playfab/multiplayer/servers/allocating-with-build-alias.md)
- [PlayFab Engagement 개요](/ko/services/playfab/live-service-management/game-configuration/title-communications/overview.md)
- [PlayFab for Unreal Engine 개요](/ko/services/playfab/sdks/unified-unreal/overview.md)
- [Postman용 PlayFab REST API 컬렉션 빠른 시작](/ko/services/playfab/sdks/postman/postman-quickstart.md)