Identity API \ Synchronize an identity PHP SDK

Send a PUT request to this resource to synchronize an identity with the underlying social network profile.

Resource/URI - Common GET POST PUT DELETE
Identities /identities.json List all identities
Identity /identities/<identity_token>.json Read identity details Delete identity
Identity /identities/<identity_token>/link.json ReLink identity
Identity /identities/<identity_token>/synchronize.json Synchronize identity
Identity /identities/<identity_token>/contacts.json Read identity contacts
Resource/URI - Provider Specific Complete Plus Data GET POST PUT DELETE
Steam Games /identities/<identity_token>/steam/games.json List all Steam games
YouTube Videos /identities/<identity_token>/youtube/videos.json List all YouTube videos
Facebook Posts /identities/<identity_token>/facebook/posts.json List all Facebook posts

Workflow

Request: the code to send to the API

Send a PUT request to the resource /identities/<identity_token>/synchronize.json to update an identity with the latest data retrieved from the social network profile. The <identity_token> has to be replaced by the unique token of an existing identity.

If necessary the OneAll API will first refresh and update the access token of the identity. It will then retrieve the user data from the social network profile and update the identity accordingly. In any case, the identity_token remains unchanged.

Per default the access token is only updated if it is expired and the complete user data is always updated with the latest social network profile data. You can include the following structure as POST data to change this behavior.

Optional POST data to include in your request

		{
			"request":{
				"synchronize":{
					"update_user_data": "#update_user_data#",
					"force_token_update": "#force_token_update#"
				}
			}
		}
Key Description
#update_user_data# Default: true (The user data is updated)
Set to false if you only want to update the access token but not the user data.
#force_token_update# Default: false (The access token is only refreshed in case it is expired)
Set to true to enforce the update of the access token even if it's not expired.

Result: the code returned by the API

If the synchronization was successful, the updated details of the identity and a HTTP status code 200 will be returned. In case of an error, an appropriate message body with further details on the error that occured will be included in the result.

User Contributed Notes