Négocier

Negotiate a SignalR Connection to the PubSub service, as the first step of establishing the connection. Note: SignalR client implementations expect the Hub URL to omit the /negotiate portion of this path (ex: HubConnection should be passed a URL that ends in ...playfabapi.com/pubsub). When starting the connection, SignalR clients will automatically append /negotiate to the end of the URL of the hub. The SignalR client will interpret the response object to establish a persistent connection to PubSub. https://learn.microsoft.com/aspnet/core/signalr/dotnet-client#connect-to-a-hub https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md#post-endpoint-basenegotiate-request

Allowed entity token types: title_player_account, game_server

Error codes

This operation may return the following PlayFab errors:

Error	Code
InternalServerError	1110
InvalidParams	1000
PubSubFeatureNotEnabledForTitle	2500
PubSubTooManyRequests	2501
ServiceUnavailable	1123

POST

PubSub

Negotiate

curl --request POST \
  --url https://{titleId}.playfabapi.com/PubSub/Negotiate \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '{}'

import requests

url = "https://{titleId}.playfabapi.com/PubSub/Negotiate"

payload = {}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://{titleId}.playfabapi.com/PubSub/Negotiate', 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/PubSub/Negotiate",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$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/PubSub/Negotiate"

	payload := strings.NewReader("{}")

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

	req.Header.Add("X-EntityToken", "<api-key>")
	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/PubSub/Negotiate")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/PubSub/Negotiate")

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

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "AccessToken": "WJkGtFNsLOQgoqV",
    "Url": "https://pubsub-signalr-dev-wu2-001.service.signalr.net/client/?hub=pubsubhub"
  }
}

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

Autorisations

X-EntityToken

string

header

requis

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Corps

application/json

SignalR clients make this request to initiate their connection to the PubSubHub SignalR service. Clients will interpret the response and make a persistent websocket connection to the service with the details.

CustomTags

object

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

Réponse

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

Exemple:

{
  "AccessToken": "WJkGtFNsLOQgoqV",
  "Url": "https://pubsub-signalr-dev-wu2-001.service.signalr.net/client/?hub=pubsubhub"
}

Dernière modification le 6 octobre 2026

Sujets connexes

PartyEndpoint::GetUniqueIdentifier

⌘I