Web authentication API - Revision history

Asdff45: Update possible return codes and values

2024-10-03T19:50:03Z

Update possible return codes and values

← Older revision		Revision as of 19:50, 3 October 2024
Line 17:		Line 17:
	\|-		\|-
	\| api_version		\| api_version
	\| ~~(Technically) not required. API responses will be different than described on this page when not set to 4.~~		\| Default: 1
	\| Currently 4.		\| Currently 6.
	\|-		\|-
	\| require_game_ownership		\| require_game_ownership
Line 30:		Line 30:
	\|}		\|}

	This endpoint always returns JSON encoded data. ~~If authentication was successful, it will return an HTTP status code of 200 with a JSON object:~~		This endpoint always returns JSON encoded data.

	{\| class="wikitable"		{\| class="wikitable"
			\|+ HTTP Status codes
			\|-
			! API-Version
			! Success
			! Error
			\|-
			! <= 3
			\| 200
			\| 401
			\|-
			! >= 4
			\| 200
			\| 200
			\|}

			{\| class="wikitable"
			\|+ Success json
			\|-
			! API-Version
			! Name
			! Value
			\|-
			\| <= 1
			\| []
			\| Array of hexadecimal encoded auth tokens
			\|-
			\| >= 2
	\| token		\| token
	\| Auth token is a hexadecimal encoded byte string		\| Auth token is a hexadecimal encoded byte string
	\|-		\|-
			\| >= 2
	\| username		\| username
	\| The username of the logged in user.		\| The username of the logged in user.

	\|}		\|}

	~~On non-200 status codes, the response can be JSON encoded and provide more details about the problem:~~

	{\| class="wikitable"		{\| class="wikitable"
			\|+ Error json
			\|-
			! API-Version
			! Name
			! Value
			\|-
			\| all
			\| data
			\| Always empty object "{}"
			\|-
			\| all
	\| error		\| error
	\| Error codes like <code>login-failed</code> or <code>email-authentication-required</code>		\| Error codes like <code>login-failed</code> or <code>email-authentication-required</code>
	\|-		\|-
			\| all
	\| message		\| message
	\| A more detailed error message that can be shown to the user		\| A more detailed error message that can be shown to the user
			\|-
			\| <= 3
			\| status
			\| Same value as the Status Code
	\|}		\|}

Vinzenz at 11:10, 26 August 2024

2024-08-26T11:10:42Z

← Older revision		Revision as of 11:10, 26 August 2024
Line 5:		Line 5:
	<code>https://auth.factorio.com/api-login</code>		<code>https://auth.factorio.com/api-login</code>

	Authentication requires sending an HTTP POST request with these parameters:		Authentication requires sending an HTTP POST request (Content-Type: <code>application/x-www-form-urlencoded</code>) with these parameters:

	{\| class="wikitable"		{\| class="wikitable"

Ickputzdirwech: Removed {{Languages}}

2023-11-12T09:10:20Z

Removed {{Languages}}

← Older revision		Revision as of 09:10, 12 November 2023
Line 1:		Line 1:
	~~{{Languages}}~~
	<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal\|Internal API]]</div>		<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal\|Internal API]]</div>

Vinzenz: Update to api_version 4

2022-03-07T16:55:23Z

Update to api_version 4

← Older revision		Revision as of 16:55, 7 March 2022
Line 11:		Line 11:
	\| username		\| username
	\| Required.		\| Required.
	\| Account username.		\| Account username or e-mail.
	\|-		\|-
	\| password		\| password
Line 18:		Line 18:
	\|-		\|-
	\| api_version		\| api_version
	\| ~~Not~~ required.		\| (Technically) not required. API responses will be different than described on this page when not set to 4.
	\| Currently 2.		\| Currently 4.
	\|-		\|-
	\| require_game_ownership		\| require_game_ownership
	\| Not required.		\| Not required.
	\| If set to 'true', will fail authentication if the user account hasn't actually purchased Factorio.		\| If set to 'true', will fail authentication if the user account hasn't actually purchased Factorio.
			\|-
			\| email_authentication_code
			\| Not required.
			\| If a previous login failed with <code>email-authentication-required</code>, email authentication can be completed by including the code sent to the user via mail.

	\|}		\|}

	This endpoint always returns JSON encoded data. If authentication was successful, it will return an HTTP status code of 200 with a JSON ~~list containing a single item~~: ~~the auth~~ token~~. The auth~~ token ~~seems to always be~~ a hexadecimal encoded ~~15-~~byte string of ~~random bytes~~.		This endpoint always returns JSON encoded data. If authentication was successful, it will return an HTTP status code of 200 with a JSON object:

			{\| class="wikitable"
			\| token
			\| Auth token is a hexadecimal encoded byte string
			\|-
			\| username
			\| The username of the logged in user.

			\|}

			On non-200 status codes, the response can be JSON encoded and provide more details about the problem:

			{\| class="wikitable"
			\| error
			\| Error codes like <code>login-failed</code> or <code>email-authentication-required</code>
			\|-
			\| message
			\| A more detailed error message that can be shown to the user

			\|}

	~~TODO: exceptions and stuffs~~.		Clients causing a lot of errors like <code>login-failed</code> will be rate limited.

	[[Category:Technical]]		[[Category:Technical]]

Bilka at 09:58, 25 February 2022

2022-02-25T09:58:15Z

← Older revision		Revision as of 09:58, 25 February 2022
Line 1:		Line 1:
	{{Languages}}		{{Languages}}
	<div align="center">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal\|Internal API]]</div>		<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal\|Internal API]]</div>

	Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:		Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:

Bilka: Better format for API category

2022-02-25T09:55:26Z

Better format for API category

← Older revision		Revision as of 09:55, 25 February 2022
Line 1:		Line 1:
	{{Languages}}		{{Languages}}
	'''Category:''' [~~https://wiki.factorio.com/~~Factorio_HTTP_API_usage_guidelines#Internal ~~internal~~]		<div align="center">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal\|Internal API]]</div>

	Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:		Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:

Vinzenz: add category

2022-01-21T09:46:31Z

add category

← Older revision		Revision as of 09:46, 21 January 2022
Line 1:		Line 1:
	{{Languages}}		{{Languages}}
			'''Category:''' [https://wiki.factorio.com/Factorio_HTTP_API_usage_guidelines#Internal internal]

	Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:		Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:

Gangsir: Gangsir moved page Web Authentication API to Web authentication API: Downcasing to style guide compliance.

2017-08-25T19:04:47Z

Gangsir moved page Web Authentication API to Web authentication API: Downcasing to style guide compliance.

← Older revision		Revision as of 19:04, 25 August 2017
(No difference)

Gangsir: Added languages template, must be on all pages

2017-01-08T19:00:25Z

Added languages template, must be on all pages

← Older revision		Revision as of 19:00, 8 January 2017
Line 1:		Line 1:
	~~[[Category:Technical]]~~		{{Languages}}

	Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:		Factorio's Web Authentication API endpoint gives you a token in exchange for your username and password, which is used by several other Factorio web API endpoints. The authentication endpoint is located at:

Line 27:		Line 28:

	TODO: exceptions and stuffs.		TODO: exceptions and stuffs.

			[[Category:Technical]]

Lexxy Fox at 04:24, 8 January 2017

2017-01-08T04:24:39Z

← Older revision		Revision as of 04:24, 8 January 2017
Line 18:		Line 18:
	\| Not required.		\| Not required.
	\| Currently 2.		\| Currently 2.
			\|-
			\| require_game_ownership
			\| Not required.
			\| If set to 'true', will fail authentication if the user account hasn't actually purchased Factorio.
	\|}		\|}