Validate invite token API - Revision history

Fizzer at 02:35, 18 April 2026

2026-04-18T02:35:37Z

Fizzer at 03:39, 13 November 2017

2017-11-13T03:39:31Z

54.167.11.21: Add vacation info on API

2016-09-02T21:33:00Z

Add vacation info on API

← Older revision		Revision as of 21:33, 2 September 2016
Line 20:		Line 20:
	* levelForMapUsage: The level the system considers them when determining what maps they can use. If their level is 5, but their levelForMapUsage is 10, they can use maps that unlock at 6-10, even though their level isn't techincally high enough.		* levelForMapUsage: The level the system considers them when determining what maps they can use. If their level is 5, but their levelForMapUsage is 10, they can use maps that unlock at 6-10, even though their level isn't techincally high enough.
	* featuresUnlocked: What features they've unlocked, either from leveling up or purchasing a membership.		* featuresUnlocked: What features they've unlocked, either from leveling up or purchasing a membership.
			* onVacationUntil: Expiration date of current vacation.

	== Template IDs ==		== Template IDs ==

Fizzer at 01:41, 19 December 2014

2014-12-19T01:41:55Z

← Older revision		Revision as of 01:41, 19 December 2014
Line 3:		Line 3:
	Of course, if you invite a player to a game with their token, the [[Create game API]] will inform you that it's invalid. But you may wish to determine whether or not it's valid before attempting to create a game, such as when a new player signs up on your site.		Of course, if you invite a player to a game with their token, the [[Create game API]] will inform you that it's invalid. But you may wish to determine whether or not it's valid before attempting to create a game, such as when a new player signs up on your site.

	You can do this by calling the following API: ~~http~~://warlight.net/API/ValidateInviteToken?Token=12345678		You can do this by calling the following API: https://www.warlight.net/API/ValidateInviteToken?Token=12345678

	To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].		To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].
Line 29:		Line 29:
	To use this, provide a parameter named TemplateIDs (either via the query string or POST param) which contains a comma-delimited list of template IDs. You may pass up to 20 template IDs per call.		To use this, provide a parameter named TemplateIDs (either via the query string or POST param) which contains a comma-delimited list of template IDs. You may pass up to 20 template IDs per call.

	An example request would look like ~~http~~://warlight.net/API/ValidateInviteToken?Token=12345678&TemplateIDs=342040,342041,342042,342043		An example request would look like https://www.warlight.net/API/ValidateInviteToken?Token=12345678&TemplateIDs=342040,342041,342042,342043

	The API will return results for each template ID provided in the returned JSON. Each template will return a "result" node that contains the string "CanUseTemplate", "CannotUseTemplate", or another string if an error occurred. If "CannotUseTemplate" is returned, there will be an additional node named "reasonCode" that explains why the player was unable to use the template.		The API will return results for each template ID provided in the returned JSON. Each template will return a "result" node that contains the string "CanUseTemplate", "CannotUseTemplate", or another string if an error occurred. If "CannotUseTemplate" is returned, there will be an additional node named "reasonCode" that explains why the player was unable to use the template.

Fizzer at 06:38, 1 September 2013

2013-09-01T06:38:27Z

← Older revision		Revision as of 06:38, 1 September 2013
Line 23:		Line 23:
	== Template IDs ==		== Template IDs ==

	Optionally, you can also provide a list of Template IDs to this API. The API will check if the player has access to be a part of games created by the [[Create ~~Game~~ API]] using this template.		Optionally, you can also provide a list of Template IDs to this API. The API will check if the player has access to be a part of games created by the [[Create game API]] using this template.

	This is helpful if you plan to invite them to a game via the API and you don't want to manually check their featuresUnlocked parameter against the features you know that your template uses.		This is helpful if you plan to invite them to a game via the API and you don't want to manually check their featuresUnlocked parameter against the features you know that your template uses.

Fizzer at 06:37, 1 September 2013

2013-09-01T06:37:53Z

@@ Line 12: / Line 12: @@
 * name: The player's WarLight nickname.
 * isMember: True if the player has purchased a WarLight membership.
 * color: The player's preferred WarLight color.
 * tagLine: The tagline the player has set up to display on their profile page.
 * clotpass: See [[CLOT Authentication]]
 ==See Also==

Fizzer at 06:56, 3 May 2013

2013-05-03T06:56:45Z

← Older revision		Revision as of 06:56, 3 May 2013
Line 14:		Line 14:
	* color: The player's preferred WarLight color.		* color: The player's preferred WarLight color.
	* tagLine: The tagline the player has set up to display on their profile page.		* tagLine: The tagline the player has set up to display on their profile page.
			* clotpass: See [[CLOT Authentication]]

	==See Also==		==See Also==

Fizzer at 06:49, 1 May 2013

2013-05-01T06:49:20Z

← Older revision		Revision as of 06:49, 1 May 2013
Line 3:		Line 3:
	Of course, if you invite a player to a game with their token, the [[Create game API]] will inform you that it's invalid. But you may wish to determine whether or not it's valid before attempting to create a game, such as when a new player signs up on your site.		Of course, if you invite a player to a game with their token, the [[Create game API]] will inform you that it's invalid. But you may wish to determine whether or not it's valid before attempting to create a game, such as when a new player signs up on your site.

	You can do this by calling the following API: http://warlight.net/API/ValidateInviteToken~~.aspx~~?Token=12345678		You can do this by calling the following API: http://warlight.net/API/ValidateInviteToken?Token=12345678

	To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].		To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].

Fizzer at 21:43, 24 October 2012

2012-10-24T21:43:07Z

← Older revision		Revision as of 21:43, 24 October 2012
Line 5:		Line 5:
	You can do this by calling the following API: http://warlight.net/API/ValidateInviteToken.aspx?Token=12345678		You can do this by calling the following API: http://warlight.net/API/ValidateInviteToken.aspx?Token=12345678

	To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken		To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].

	~~You can get your API~~ token ~~from~~ the ~~[[Get API Token API]]~~.		This will return the following fields about the player whose token you provided:

			* tokenIsValid: This simply tells you that the token does belong to a WarLight player.
			* name: The player's WarLight nickname.
			* isMember: True if the player has purchased a WarLight membership.
			* color: The player's preferred WarLight color.
			* tagLine: The tagline the player has set up to display on their profile page.

	==See Also==		==See Also==

Fizzer at 14:20, 17 September 2012

2012-09-17T14:20:31Z

← Older revision		Revision as of 14:20, 17 September 2012
Line 5:		Line 5:
	You can do this by calling the following API: http://warlight.net/API/ValidateInviteToken.aspx?Token=12345678		You can do this by calling the following API: http://warlight.net/API/ValidateInviteToken.aspx?Token=12345678

	~~In place of the "Token" parameter~~, you ~~may place an invite token number or an~~ e-mail address ~~that a user has provided you~~.		To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken

			You can get your API token from the [[Get API Token API]].

	==See Also==		==See Also==

			* [[Get API Token API]]
	* [[Create game API]]		* [[Create game API]]

	[[Category:API]]		[[Category:API]]

← Older revision		Revision as of 02:35, 18 April 2026
Line 1:		Line 1:
	If you're creating a system that invites players to ~~Warzone~~ games via the [[Create game API]], you may wish to validate whether or not an invite token or e-mail address is valid before you attempt to invite them to a game.		If you're creating a system that invites players to War.app games via the [[Create game API]], you may wish to validate whether or not an invite token or e-mail address is valid before you attempt to invite them to a game.

	Of course, if you invite a player to a game with their token, the [[Create game API]] will inform you that it's invalid. But you may wish to determine whether or not it's valid before attempting to create a game, such as when a new player signs up on your site.		Of course, if you invite a player to a game with their token, the [[Create game API]] will inform you that it's invalid. But you may wish to determine whether or not it's valid before attempting to create a game, such as when a new player signs up on your site.

	You can do this by calling the following API: https://www.~~warzone~~.~~com~~/API/ValidateInviteToken?Token=12345678		You can do this by calling the following API: https://www.war.app/API/ValidateInviteToken?Token=12345678

	To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].		To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].
Line 9:		Line 9:
	This will return the following fields about the player whose token you provided:		This will return the following fields about the player whose token you provided:

	* tokenIsValid: This simply tells you that the token does belong to a ~~Warzone~~ player.		* tokenIsValid: This simply tells you that the token does belong to a War.app player.
	* name: The player's ~~Warzone~~ nickname.		* name: The player's War.app nickname.
	* isMember: True if the player has purchased a ~~Warzone~~ membership.		* isMember: True if the player has purchased a War.app membership.
	* level: Their current level.		* level: Their current level.
	* color: The player's preferred ~~Warzone~~ color.		* color: The player's preferred War.app color.
	* tagLine: The tagline the player has set up to display on their profile page.		* tagLine: The tagline the player has set up to display on their profile page.
	* clotpass: See [[CLOT Authentication]]		* clotpass: See [[CLOT Authentication]]
Line 30:		Line 30:
	To use this, provide a parameter named TemplateIDs (either via the query string or POST param) which contains a comma-delimited list of template IDs. You may pass up to 20 template IDs per call.		To use this, provide a parameter named TemplateIDs (either via the query string or POST param) which contains a comma-delimited list of template IDs. You may pass up to 20 template IDs per call.

	An example request would look like https://www.~~warzone~~.~~com~~/API/ValidateInviteToken?Token=12345678&TemplateIDs=342040,342041,342042,342043		An example request would look like https://www.war.app/API/ValidateInviteToken?Token=12345678&TemplateIDs=342040,342041,342042,342043

	The API will return results for each template ID provided in the returned JSON. Each template will return a "result" node that contains the string "CanUseTemplate", "CannotUseTemplate", or another string if an error occurred. If "CannotUseTemplate" is returned, there will be an additional node named "reasonCode" that explains why the player was unable to use the template.		The API will return results for each template ID provided in the returned JSON. Each template will return a "result" node that contains the string "CanUseTemplate", "CannotUseTemplate", or another string if an error occurred. If "CannotUseTemplate" is returned, there will be an additional node named "reasonCode" that explains why the player was unable to use the template.

← Older revision		Revision as of 03:39, 13 November 2017
Line 1:		Line 1:
	If you're creating a system that invites players to ~~WarLight~~ games via the [[Create game API]], you may wish to validate whether or not an invite token or e-mail address is valid before you attempt to invite them to a game.		If you're creating a system that invites players to Warzone games via the [[Create game API]], you may wish to validate whether or not an invite token or e-mail address is valid before you attempt to invite them to a game.

	Of course, if you invite a player to a game with their token, the [[Create game API]] will inform you that it's invalid. But you may wish to determine whether or not it's valid before attempting to create a game, such as when a new player signs up on your site.		Of course, if you invite a player to a game with their token, the [[Create game API]] will inform you that it's invalid. But you may wish to determine whether or not it's valid before attempting to create a game, such as when a new player signs up on your site.

	You can do this by calling the following API: https://www.~~warlight~~.~~net~~/API/ValidateInviteToken?Token=12345678		You can do this by calling the following API: https://www.warzone.com/API/ValidateInviteToken?Token=12345678

	To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].		To call this programmatically, you can POST your e-mail address and API token to this page in the format Email=your@email.com&APIToken=yourapitoken You can get your API token from the [[Get API Token API]].
Line 9:		Line 9:
	This will return the following fields about the player whose token you provided:		This will return the following fields about the player whose token you provided:

	* tokenIsValid: This simply tells you that the token does belong to a ~~WarLight~~ player.		* tokenIsValid: This simply tells you that the token does belong to a Warzone player.
	* name: The player's ~~WarLight~~ nickname.		* name: The player's Warzone nickname.
	* isMember: True if the player has purchased a ~~WarLight~~ membership.		* isMember: True if the player has purchased a Warzone membership.
	* level: Their current level.		* level: Their current level.
	* color: The player's preferred ~~WarLight~~ color.		* color: The player's preferred Warzone color.
	* tagLine: The tagline the player has set up to display on their profile page.		* tagLine: The tagline the player has set up to display on their profile page.
	* clotpass: See [[CLOT Authentication]]		* clotpass: See [[CLOT Authentication]]
Line 30:		Line 30:
	To use this, provide a parameter named TemplateIDs (either via the query string or POST param) which contains a comma-delimited list of template IDs. You may pass up to 20 template IDs per call.		To use this, provide a parameter named TemplateIDs (either via the query string or POST param) which contains a comma-delimited list of template IDs. You may pass up to 20 template IDs per call.

	An example request would look like https://www.~~warlight~~.~~net~~/API/ValidateInviteToken?Token=12345678&TemplateIDs=342040,342041,342042,342043		An example request would look like https://www.warzone.com/API/ValidateInviteToken?Token=12345678&TemplateIDs=342040,342041,342042,342043

	The API will return results for each template ID provided in the returned JSON. Each template will return a "result" node that contains the string "CanUseTemplate", "CannotUseTemplate", or another string if an error occurred. If "CannotUseTemplate" is returned, there will be an additional node named "reasonCode" that explains why the player was unable to use the template.		The API will return results for each template ID provided in the returned JSON. Each template will return a "result" node that contains the string "CanUseTemplate", "CannotUseTemplate", or another string if an error occurred. If "CannotUseTemplate" is returned, there will be an additional node named "reasonCode" that explains why the player was unable to use the template.