API リファレンス

PlayFab API リファレンスへようこそ。 ここでは、参考資料と Api のしくみについて説明します。 各 API 参照は、いくつかの異なるセクションに分割されます。

エンドポイント

エンドポイントは、API 要求を行うことができる HTTP URL です。 REST メソッドの型の前には (例: GET、POST)。 さらに、titleId をゲーム titleId に置き換える必要があります。

例:

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

リクエストの本文

要求本文は、API サービスに (JSON) として送信されるオブジェクトモデルです。 これらのモデルには、API と共にペイロードとして送信する必要があるプロパティが含まれています。 一部のプロパティは必須としてマークされますが、それ以外は省略可能です。

Responses

API サービスは、モデルとしてシリアル化解除できる JSON ペイロードで、200 OK を返します。 次の例では、Login API は、LoginResult の型へのシリアル化解除を呼び出します。

Responses

何らかの理由で応答が失敗した場合、400の不正な要求が受信されます。 これは、API サービスが不正な要求に関する情報を返していることを意味します。 多くの場合、API 呼び出しのパラメーターが見つからない場合や、その他の理由が考えられます。 ApiErrorWrapper オブジェクトには、エラーコード、エラーの詳細、サーバーからのエラーメッセージなど、エラーに関する重要な情報が含まれています。

セキュリティ

各 API には、各要求のヘッダーで渡す必要があるなんらかの形式のセキュリティがあります。 定義する必要がある項目については、このセクションを参照してください。 これはログイン要求からのセッションチケットでも、サーバー api 要求を作成する場合はタイトルの秘密キーでもかまいません。

モデル定義

API サービスからの各応答には、応答に1つ以上のモデルを含めることができます。 これらは ApiErrorWrapper の下にあり、各モデルは API と同じドキュメントで表されます。 各モデルは、応答親モデルにもリンクされています。 各 API ページの [定義] セクションにアクセスして、API でサポートされているモデルの一覧を表示することもできます。

イベントモデルの定義

Playstream イベントモデルのリファレンスには、自動的に生成される playstream イベント型のモデルが含まれています。 各イベントの種類には、送信されたときにイベントのデータの一部として含まれるプロパティのセットがあります。