Mod publish API - Revision history

Ickputzdirwech: Removed {{Languages}}

2023-11-12T09:07:35Z

Removed {{Languages}}

← Older revision		Revision as of 09:07, 12 November 2023
Line 123:		Line 123:
	</syntaxhighlight>		</syntaxhighlight>

	~~{{Languages}}~~[[Category:Technical]]		[[Category:Technical]]

Vinzenz at 15:31, 26 July 2022

2022-07-26T15:31:06Z

← Older revision		Revision as of 15:31, 26 July 2022
Line 1:		Line 1:
	<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#~~Experimental~~\|~~Experimental~~ API]]</div>		<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Public\|Public API]]</div>

	The mod publish API is used to add new mods to the Factorio mod portal. It requires an API key with the <code>ModPortal: Publish Mods</code> usage, which can be created on https://factorio.com/profile.		The mod publish API is used to add new mods to the Factorio mod portal. It requires an API key with the <code>ModPortal: Publish Mods</code> usage, which can be created on https://factorio.com/profile.

Vinzenz at 15:29, 26 July 2022

2022-07-26T15:29:51Z

← Older revision		Revision as of 15:29, 26 July 2022
Line 10:		Line 10:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	\| URL \|\| https://mods.factorio.com/api/~~experimental~~/mods/init_publish		\| URL \|\| https://mods.factorio.com/api/v2/mods/init_publish
	\|-		\|-
	\| HTTP Method \|\| <code>POST</code>		\| HTTP Method \|\| <code>POST</code>
Line 93:		Line 93:

	MOD_PORTAL_URL = "https://mods.factorio.com"		MOD_PORTAL_URL = "https://mods.factorio.com"
	INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/~~experimental~~/mods/init_publish"		INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/v2/mods/init_publish"

	apikey = getenv("MOD_UPLOAD_API_KEY")		apikey = getenv("MOD_UPLOAD_API_KEY")

Bilka: whitespace

2022-07-19T11:08:34Z

whitespace

← Older revision		Revision as of 11:08, 19 July 2022
Line 87:		Line 87:
	\| ModAlreadyExists \|\| Mod name already exists in mod portal		\| ModAlreadyExists \|\| Mod name already exists in mod portal
	\|-		\|-

	\|}		\|}


	== Python example ==		== Python example ==
Line 123:		Line 121:

	</syntaxhighlight>		</syntaxhighlight>


	{{Languages}}[[Category:Technical]]		{{Languages}}[[Category:Technical]]

Vinzenz at 13:08, 28 June 2022

2022-06-28T13:08:11Z

← Older revision		Revision as of 13:08, 28 June 2022
Line 38:		Line 38:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	\| URL \|\| <code>$upload_url</code> URL returned by the ~~init_upload~~ endpoint		\| URL \|\| <code>$upload_url</code> URL returned by the init_publish endpoint
	\|-		\|-
	\| HTTP Method \|\| <code>POST</code>		\| HTTP Method \|\| <code>POST</code>

Vinzenz: Created page with "
'''Category:''' Experimental API
The mod publish API is used to add new mods to the..."

2022-06-28T13:07:23Z

Created page with "<div align="center" class="stub">'''Category:''' Experimental API</div> The mod publish API is used to add new mods to the..."

New page

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Experimental|Experimental API]]</div>
The mod publish API is used to add new mods to the Factorio mod portal. It requires an API key with the <code>ModPortal: Publish Mods</code> usage, which can be created on https://factorio.com/profile.

It accepts <code>multipart/form-data</code> HTTP requests and responds with JSON encoded objects.

== Endpoints ==

=== init_publish ===

{| class="wikitable"
|-
| URL || https://mods.factorio.com/api/experimental/mods/init_publish
|-
| HTTP Method || <code>POST</code>
|-
|}

HTTP Request Header
{| class="wikitable"
| Authorization|| <code>Bearer $APIKey</code> || Authorization header with the APIKey and a "Bearer " prefix -> "Bearer $APIKey"
|}

HTTP Request Body
{| class="wikitable"
| mod || string || Name of the mod that will be published.
|}

JSON object response
{| class="wikitable"
| upload_url || string || URL the mod zip file should be uploaded to
|-
| error || string || This attribute only appears on <strong>failed</strong> requests.
|-
| message || string || This attribute only appears on <strong>failed</strong> requests. Has details about the problem.
|}

=== finish_upload ===
{| class="wikitable"
|-
| URL || <code>$upload_url</code> URL returned by the init_upload endpoint
|-
| HTTP Method || <code>POST</code>
|-
|}

HTTP Request Body
{| class="wikitable"
| file || file ||Mod zip file
|-
| description || string, optional || Mod description in markdown format
|-
| category || enum, optional || Mod category, See [[Mod details API#Category]]
|-
| license || enum, optional || Mod category, See [[Mod details API#License]]
|-
| source_url || url, optional || Url to mod source code repository
|}

JSON object response
{| class="wikitable"
| success || bool || This attribute only appears on <strong>successful</strong> uploads. It's set to true.
|-
| url || string || This attribute only appears for <strong>successful</strong> requests. URL path to get mod details endpoint
|-
| error || string || This attribute only appears on <strong>failed</strong> uploads.
|-
| message || string || This attribute only appears on <strong>failed</strong> uploads. Has details about the problem.
|}

== Possible API Error Responses ==
Possible values for the <code>error</code> property of API responses
{| class="wikitable"
| InvalidApiKey || Missing or invalid API key for the current endpoint
|-
| InvalidRequest || Invalid request.
|-
| InternalError || Internal error, please try again later.
|-
| Forbidden || Insufficent permission for current endpoint
|-
| Unknown || Unknown error, please try again later.
|-
| InvalidModRelease || Invalid release data in info.json
|-
| InvalidModUpload || Invalid mod data in zipfile
|-
| ModAlreadyExists || Mod name already exists in mod portal
|-

|}

== Python example ==
<syntaxhighlight lang="python">

MOD_PORTAL_URL = "https://mods.factorio.com"
INIT_UPLOAD_URL = f"{MOD_PORTAL_URL}/api/experimental/mods/init_publish"

apikey = getenv("MOD_UPLOAD_API_KEY")
modname = sys.argv[1]
filepath = sys.argv[2]

request_body = data = {"mod": modname}
request_headers = {"Authorization": f"Bearer {apikey}"}

response = requests.post(INIT_UPLOAD_URL, data=request_body, headers=request_headers)

if not response.ok:
print(f"init_upload failed: {response.text}")
sys.exit(1)

upload_url = response.json()["upload_url"]

with open(filepath, "rb") as f:
request_body = {"file": f}
response = requests.post(upload_url, files=request_body, data={"description": "# published via API"})

if not response.ok:
print(f"upload failed: {response.text}")
sys.exit(1)

print(f"upload successful: {response.text}")

</syntaxhighlight>

{{Languages}}[[Category:Technical]]