Quickstart: PlayFab REST API collection for Postman

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

Setting up

Adding PlayFab Collections

  • Select Import (top left of the window)

    Postman Import

  • Select Import From Link

    Postman Import From Link

  • Paste the following link into the URL text box and select Import

    https://raw.githubusercontent.com/PlayFab/PostmanCollection/master/playfab.json
    
    • If you are trying to download the beta SDK, go to the playfab.json file in the Postman Beta GitHub repository

    • Select View Raw

      Postman View Raw Beta JSON

    • Copy the URL from the browser, paste the link into the URL text box and select Import

  • You should now see the PlayFab Postman SDK under the Collections tab (top left of the window)

    Postman PlayFab Collection

Adding Environment Variables

  • Select Manage Environments (cog icon at the top right of the window)

    Postman Manage Environments

  • Select Add to create a new environment

  • Name your environment - we recommend "[titleId] - Test Environment"

Note

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
    TitleId [titleId] [titleId]
    SecretKey [secretKey] [secretKey]
    EntityToken

Note

You can learn more about title secret keys and where to find them in the Secret Key Management documentation

Postman Create Environment

  • Select Update to save your new environment

  • Exit out of the Manage Environment window and select the environment dropdown to switch to your new environment (top right of the window)

    Postman Select Environment

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 amount of players:

  • Under the PlayFab Collections folder, expand the Authentication namespace and select GetEntityToken

  • Under Headers, uncheck X-Authorization

    Postman Get Entity Token Header

  • Select Send

  • Set the returned entity token to your EntityToken environment variable

    • In the response, highlight the EntityToken string (don't forget the '==')

    • Right-click and select Set: [Environment] for your new environment

    • Select EntityToken

      Postman Set Entity Token Variable

Note

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

Troubleshooting

  • Title id / secret key mismatch
    • If you are 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 are 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.