Access to this page requires authorization. You can try
.
Access to this page requires authorization. You can try
Get started with the PlayFab REST API collection for Postman. Follow steps to install the package and try out example code for basic tasks. PlayFab is a complete backend platform for live games. Use the PlayFab REST API collection for Postman to:
Get an entity token
Add/modify/delete entities in a title
Configure title content
API reference documentation
|
PlayFab Postman Collection GitHub repository
Prerequisites
A
PlayFab developer account
The
Postman native app
An OS running
TLS
1.2 or higher (
Windows support for TLS 1.2
)
Adding PlayFab Collections
Create Workspace
Paste the following link into the URL text box and select
Continue
and
Import
https://raw.githubusercontent.com/PlayFab/PostmanCollection/master/playfabV2.json
If you're trying to download the beta SDK, go to the playfabV2.json file in the
Postman Beta GitHub repository
Select
View Raw
You can find your title id by logging into
Game Manager
and copying the hex value below your title name on the
My Studios and Titles
main page.
Add the following 3 variables to the environment:
Variable
Initial Value
Current Value
Getting a Title Entity Token
One way to interact with PlayFab's
Entity Programming Model
is to get a Title Entity Token. This can be useful if you want to make changes to title config data, or if you want to make adjustments to a large number of players:
Under the
PlayFab Collections
folder, expand the
Authentication
namespace and select
GetEntityToken
Under
Headers
, uncheck
X-Authorization
Set the returned entity token to your
EntityToken
environment variable
In the response, highlight the
EntityToken
string
Right-click and select
Set: [Environment]
for your new environment
Select
EntityToken
Entity tokens expire after
24 hours
. Afterwards, you need to re-run
GetEntityToken
to get a new entity token and update your environment variable
Getting a Title_Player_Account Entity Token
Another way to interact with PlayFab's
Entity Programming Model
is to get a Title_Player_Account Entity Token. This is useful if you want to make changes to a single player:
Under the
PlayFab Collections
folder, expand the
Client
namespace and select
LoginWithCustomID
Under
Body
, change the
CreateAccount
value from
false
to
true
Select
Send
Set the returned entity token to your
EntityToken
environment variable
In the response, highlight the
EntityToken
string
Right-click and select
Set: [Environment]
for your new environment
Select
EntityToken
Title ID / secret key mismatch
If you're trying to get a title entity token and receiving a
401: Unauthorized
error, make sure the title ID and secret keys are correct by logging into
Game Manager
Expired entity token
If you previously obtained an entity token and are unsuccessfully attempting to call other APIs, your entity token might be expired. Get another entity token, save it into the
EntityToken
environment variable, and attempt to call the previous API again
Incorrect entity token type
There are different types of entities (see
Available built-in entity types
). Different APIs allow different entity types - for example, you might be attempting to call
GetLanguageList
with a title_player_account entity token instead of a title entity token
Incorrect environment:
Make sure you're using the proper environment by checking the environment dropdown
(top right of the window)
Next Steps
You now have an entity token to pass into other API calls to start setting up your PlayFab title.
PlayFab Quickstarts >
API References >
