REST API の概要
PlayFab REST API リファレンスへようこそ。ここでは、API の動作を理解するためのリファレンス資料を提供します。各 API リファレンスは複数のセクションに分かれています。エンドポイント
エンドポイントとは、API リクエストの送信先となる HTTP URL です。先頭には REST メソッドの種類 (GET、POST など) が付きます。また、titleId はゲームの titleId に置き換える必要があります。 例:リクエスト本文
リクエスト本文は、API サービスに (JSON として) 送信されるオブジェクト モデルです。これらのモデルには、ペイロードとして API と一緒に送信する必要があるプロパティが含まれます。プロパティによっては 必須 としてマークされているものと、省略可能 としてマークされているものがあります。レスポンス
API サービスは、モデルとしてデシリアライズできる JSON ペイロードとともに 200 OK を返します。以下の例では、Login API 呼び出しは LoginResult 型としてデシリアライズされます。 レスポンスが失敗した場合は、4XX エラー レスポンスが返されます。400 Bad Request は、API 呼び出しでパラメーターが不足している、あるいはレート制限の超過や検証エラーなどが原因で発生することがよくあります。4XX エラーが発生した場合は、リクエストのパラメーターと認証トークンを確認し、それらが正しいことを確かめるのが最善です。ApiErrorWrapper オブジェクトには、問題の特定に役立つエラー コード、エラーの詳細、およびサーバーからのエラー メッセージなど、貴重な情報が含まれます。セキュリティ
各 API には、リクエスト ヘッダーに指定する必要があるセキュリティ情報があります。何を定義する必要があるかについては、このセクションを参照してください。これは、ログイン リクエストのセッション チケットのこともあれば、サーバー API リクエストを行う場合はタイトル シークレット キーのこともあります。同時実行
API サービスは、各タイトルからの非常に多数の同時呼び出しを処理できるように設計されていますが、単一プレイヤーやキャラクター、グループなどの単一エンティティに対して同時にアクセスできる呼び出し数には制限があります。この同時実行の制限を超えると、API はAPIConcurrentRequestLimitExceeded または ConcurrentEditError エラー コードを返します。一般に、特定のプレイヤーに対して読み取りリクエストを複数同時に行うことは安全ですが、更新リクエストは 1 度に 1 つだけ行うのが最善です。