Übersicht über die REST-API

Willkommen bei der PlayFab-REST-API-Referenz. Hier finden Sie Referenzmaterial und erhalten Einen Einblick in die Funktionsweise unserer APIs. Jeder API-Verweis ist in mehrere verschiedene Abschnitte unterteilt.

Endpunkt

Der Endpunkt ist die HTTP-URL, für die Sie API-Anforderungen senden können. Ihm ist ein REST-Methodentyp vorangestellt (z. B. GET, POST). Außerdem muss die titleId durch Ihr Spiel titleId ersetzt werden.

Beispiel:

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

Anforderungstext

Der Anforderungstext ist das Objektmodell, das als (JSON) an unseren API-Dienst gesendet wird. Diese Modelle enthalten Eigenschaften, die zusammen mit Ihrer API als Nutzlast gesendet werden müssen. Einige Eigenschaften werden als erforderlich gekennzeichnet, während andere optional sind.

Antworten

Der API-Dienst gibt entweder 200 OK mit einer JSON-Nutzlast zurück, die als Modell deserialisiert werden kann. Im folgenden Beispiel ruft die Anmelde-API deserialisieren in einen LoginResult-Typ auf.

Wenn die Antwort fehlschlägt, wird eine 4XX-Fehlerantwort empfangen. Eine 400 ungültige Anforderung kann häufig auf fehlende Parameter in Ihrem API-Aufruf oder andere Gründe zurückzuführen sein, z. B. das Überschreiten von Ratenlimits und Validierungsfehlern. Wenn ein 4XX-Fehler auftritt, sollten Sie die Anforderungsparameter und das Authentifizierungstoken überprüfen und sicherstellen, dass sie korrekt sind. Das ApiErrorWrapper-Objekt enthält wertvolle Informationen zum Fehler, einschließlich Fehlercodes, Fehlerdetails und Fehlermeldungen vom Server, um das Problem zu identifizieren.

Sicherheit

Jede API verfügt über eine Art von Sicherheit, die im Header jeder Anforderung übergeben werden muss. In diesem Abschnitt erfahren Sie, was definiert werden muss. Manchmal handelt es sich dabei um ein Sitzungsticket aus einer Anmeldeanforderung oder um Ihren geheimen Titelschlüssel, wenn Sie Server-API-Anforderungen stellen.

Parallelität

Der API-Dienst ist für die Verarbeitung einer sehr großen Anzahl gleichzeitiger Aufrufe von jedem Titel konzipiert, aber es gibt Grenzwerte und Einschränkungen für die Anzahl gleichzeitiger Aufrufe, die auf einen einzelnen Player oder eine andere einzelne Entität wie ein Zeichen oder eine Gruppe zugreifen können. Wenn dieser Parallelitätsgrenzwert überschritten wird, gibt die API einen - oder ConcurrentEditError -APIConcurrentRequestLimitExceededFehlercode zurück. Im Allgemeinen ist es sicher, mehrere Leseanforderungen für einen bestimmten Spieler gleichzeitig zu stellen, aber es ist am besten, eine einzelne Updateanforderung gleichzeitig zu stellen.

Modelldefinitionen

Jede Antwort des API-Diensts kann ein oder mehrere Modelle in der Antwort enthalten. Diese befinden sich unterhalb des ApiErrorWrappers, und jedes Modell wird im selben Dokument wie die API dargestellt. Jedes Modell ist auch im übergeordneten Antwortmodell verknüpft. Sie können auch den Abschnitt Definitionen auf jeder API-Seite besuchen, um eine Liste der von der API unterstützten Modelle anzuzeigen.

Ereignismodelldefinitionen

Die Referenz zum PlayStream-Ereignismodell enthält die Modelle der automatisch generierten PlayStream-Ereignistypen. Jeder Ereignistyp verfügt über eine Reihe von Eigenschaften, die als Teil der Daten des Ereignisses enthalten sind, unabhängig davon, wo sie gesendet werden.