- Overview:
JavaScriptSDK for the Client API of PlayFab
- Prerequisites:
- Users should be very familiar with the topics covered in our getting started guide.
To connect to the PlayFab service, your machine must be running TLS v1.2 or better.
- For Windows, this means Windows 7 and above
- Official Microsoft Documentation
- Support for SSL/TLS protocols on Windows
- Example Project: PlayFabApiTest.html & PlayFabApiTest.js:
These files are an internal PlayFab testing project, which activates and tests the core functionality of the sdk. They are not part of the sdk. You should delete these two files before integrating the sdk with your project.
They require a testTitleData.json file to exist, which is described below.
- testTitleData.json file required for example test files.
This sdk includes an optional example project that is used by PlayFab to verify sdk features are fully functional. The testTitleData.json file provides your secret title information to the unit-test project, so it can execute tests in your own PlayFab title.
The format is as follows:
{
"titleId": "your Game Title ID, found in the settings/credentials section of your dashboard on the website",
"developerSecretKey": "your PlayFab API Secret Key, found in the settings/credentials section of your dashboard on the website - NEVER SHARE THIS KEY WITH PLAYERS",
"titleCanUpdateSettings": "false", // "true" or "false", based on your Allow Client to Post Player Statistics option, found in the settings/general section of your dashboard on the website
"userName": "testUser", // Arbitrary username, you can change this to any valid username
"userEmail": "your@email.com", // This email address will be bound to the username above
"userPassword": "testPassword", // This must be the correct password for the testUser above (if that user does not exist yet, this will be the new password)
"characterName": "testCharacter" // Arbitrary characterName, you can change this to any valid characterName
}
This file must be created and placed in the root of the sdk (beside PlayFabApiTest.html & PlayFabApiTest.js), and must be named "testTitleData.json"
- Troubleshooting:
For a complete list of available APIs, check out the online documentation.
We love to hear from our developer community! Do you have ideas on how we can make our products and services better?
Our Developer Success Team can assist with answering any questions as well as process any feedback you have about PlayFab services.
Forums, Support and Knowledge Base
- Copyright and Licensing Information:
Apache License -- Version 2.0, January 2004 http://www.apache.org/licenses/
Full details available within the LICENSE file.