Account Management - Get PlayFab IDs From Kongregate IDs
Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as "user_id" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId).
POST https://titleId.playfabapi.com/Client/GetPlayFabIDsFromKongregateIDsRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-Authorization | True |
string |
This API requires a client session ticket, available from any Client Login function. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| KongregateIDs | True |
string[] |
Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
For Kongregate identifiers which have not been linked to PlayFab accounts, null will be returned. |
|
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-Authorization
This API requires a client session ticket, available from any Client Login function.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Get |
|
|
Get |
For Kongregate identifiers which have not been linked to PlayFab accounts, null will be returned. |
|
Kongregate |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
GetPlayFabIDsFromKongregateIDsRequest
| Name | Type | Description |
|---|---|---|
| KongregateIDs |
string[] |
Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length. |
GetPlayFabIDsFromKongregateIDsResult
For Kongregate identifiers which have not been linked to PlayFab accounts, null will be returned.
| Name | Type | Description |
|---|---|---|
| Data |
Mapping of Kongregate identifiers to PlayFab identifiers. |
KongregatePlayFabIdPair
| Name | Type | Description |
|---|---|---|
| KongregateId |
string |
Unique Kongregate identifier for a user. |
| PlayFabId |
string |
Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Kongregate identifier. |