使用 PlayFab 登录

Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.

Error codes

This operation may return the following PlayFab errors:

Error	Code
InvalidSignature	1273
InvalidUsernameOrPassword	1003
RequestViewConstraintParamsNotAllowed	1303

POST

Client

LoginWithPlayFab

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/LoginWithPlayFab \
  --header 'Content-Type: application/json' \
  --data '
{
  "Username": "theuser",
  "Password": "ExampleSecret",
  "TitleId": "144"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/LoginWithPlayFab"

payload = {
    "Username": "theuser",
    "Password": "ExampleSecret",
    "TitleId": "144"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({Username: 'theuser', Password: 'ExampleSecret', TitleId: '144'})
};

fetch('https://{titleId}.playfabapi.com/Client/LoginWithPlayFab', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/LoginWithPlayFab",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Username' => 'theuser',
    'Password' => 'ExampleSecret',
    'TitleId' => '144'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/LoginWithPlayFab"

	payload := strings.NewReader("{\n  \"Username\": \"theuser\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"144\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/LoginWithPlayFab")
  .header("Content-Type", "application/json")
  .body("{\n  \"Username\": \"theuser\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"144\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/LoginWithPlayFab")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Username\": \"theuser\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"144\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
    "PlayFabId": "50DF92E291CCD4C3"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

请求体

application/json

Username and password lengths are provided for information purposes. The server will validate that data passed in conforms to the field definition and report errors appropriately. It is recommended that developers not perform this validation locally, so that future updates to the username or password do not require client updates.

Password

string

必填

Password for the PlayFab account (6-100 characters)

TitleId

string

必填

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

Username

string

必填

PlayFab username for the account.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

InfoRequestParameters

object

Flags for which pieces of info to return for the user.

Show child attributes

示例:

{
  "GetUserAccountInfo": true,
  "GetUserVirtualCurrency": true,
  "GetUserData": true,
  "UserDataKeys": ["preferences", "progress"]
}

响应

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

示例:

{
  "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
  "PlayFabId": "50DF92E291CCD4C3"
}

最后修改于 2026年10月6日

⌘I

curl --request POST \
  --url https://{titleId}.playfabapi.com/Client/LoginWithPlayFab \
  --header 'Content-Type: application/json' \
  --data '
{
  "Username": "theuser",
  "Password": "ExampleSecret",
  "TitleId": "144"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Client/LoginWithPlayFab"

payload = {
    "Username": "theuser",
    "Password": "ExampleSecret",
    "TitleId": "144"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({Username: 'theuser', Password: 'ExampleSecret', TitleId: '144'})
};

fetch('https://{titleId}.playfabapi.com/Client/LoginWithPlayFab', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Client/LoginWithPlayFab",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Username' => 'theuser',
    'Password' => 'ExampleSecret',
    'TitleId' => '144'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Client/LoginWithPlayFab"

	payload := strings.NewReader("{\n  \"Username\": \"theuser\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"144\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Client/LoginWithPlayFab")
  .header("Content-Type", "application/json")
  .body("{\n  \"Username\": \"theuser\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"144\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Client/LoginWithPlayFab")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Username\": \"theuser\",\n  \"Password\": \"ExampleSecret\",\n  \"TitleId\": \"144\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "SessionTicket": "50DF92E291CCD4C3---A54F-8D3909FF54DEE10-B7817722BC94E536.A6DCCFE1C9709ABB",
    "PlayFabId": "50DF92E291CCD4C3"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

使用 PlayFab 登录

Error codes

请求体

响应