> ## 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 參考概觀 > PlayFab REST API 參考的概觀，包括端點、要求和回應格式、驗證，以及每個 API 區段的結構方式。 # REST API 概觀 歡迎使用 PlayFab REST API 參考。您可以在這裡找到參考資料，並深入了解我們的 API 如何運作。每個 API 參考都分成數個不同的區段。 ## 端點 端點是您可以對其發出 API 要求的 HTTP URL。其前面會加上 REST 方法類型 (例如 GET、POST)。此外，titleId 必須取代為您遊戲的 titleId。 範例： ```html theme={null} POST https://[titleId].playfabapi.com/Client/LoginWithCustomID ``` ## 要求本文 要求本文是以 (JSON) 形式傳送至我們 API 服務的物件模型。這些模型包含需要隨 API 一起作為承載傳送的屬性。有些屬性標示為**必要**，其他則為**選用**。 ## 回應 API 服務會傳回 200 OK 及可還原序列化為模型的 JSON 承載。在下列範例中，Login API 呼叫會還原序列化為 LoginResult 類型。 包含 LoginResult 的 200 OK 回應範例 如果回應失敗，則會收到 4XX 錯誤回應。400 Bad Request 通常是因為 API 呼叫中缺少參數，或其他原因，例如超過速率限制和驗證錯誤。如果您遇到 4XX 錯誤，最好檢查要求參數和驗證權杖，並確定它們正確無誤。ApiErrorWrapper 物件包含有關錯誤的寶貴資訊，包括來自伺服器的錯誤碼、錯誤詳細資料和錯誤訊息，以協助識別問題。 ## 安全性 每個 API 都有某種形式的安全性，需要在每個要求的標頭中傳遞。請參閱本區段以了解需要定義的內容。有時這是來自登入要求的工作階段票證，如果您要發出伺服器 API 要求，也可能是您遊戲的祕密金鑰。 ## 並行 API 服務的設計可處理來自每個遊戲的大量並行呼叫，但對於可存取單一玩家或其他單一實體 (例如角色或群組) 的並行呼叫數目，則有所限制。如果超過此並行限制，API 會傳回 `APIConcurrentRequestLimitExceeded` 或 `ConcurrentEditError` 錯誤碼。一般而言，針對指定玩家同時發出多個讀取要求是安全的，但最好一次只發出一個更新要求。 ## 模型定義 API 服務的每個回應都可以在回應中包含一或多個模型。這些模型位於 ApiErrorWrapper 下方，且每個模型都會在與 API 相同的文件中呈現。每個模型也會在回應的父模型中加上連結。您也可以造訪每個 API 頁面中的定義區段，以查看 API 支援的模型清單。 ### 事件模型定義 [PlayStream 事件模型參考](/zh-TW/services/playfab/api-references/events)包含自動產生之 PlayStream 事件類型的模型。每個事件類型都有一組屬性，無論事件資料傳送到何處，這些屬性都會包含在其中。 ## Related topics - [PartyXboxLive C/C++ API 概觀](/zh-TW/services/playfab/multiplayer/networking/xblreference/partyxboxlive_members.md) - [PlayFab Lobby 概觀](/zh-TW/services/playfab/multiplayer/lobby/index.md) - [XSAPI C 概觀](/zh-TW/services/xbox-services/fundamentals/xbox-services-api/live-xsapi-flat-c.md) - [物品與庫存概觀](/zh-TW/services/playfab/economy-monetization/economy-v2/inventory/items-and-inventory-overview.md) - [概觀](/zh-TW/build/console-features/audio/overviews/index.md)