Factorio HTTP API usage guidelines: Difference between revisions
Jump to navigation
Jump to search
m (add wiki category) |
No edit summary |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community. | Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community. | ||
We ask developers to: | We ask developers to: | ||
* ensure user privacy, e.g. by properly securing account secrets like passwords or | * ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys. | ||
* respect server resources, e.g. by using exponential backoff in case of errors. | * respect server resources, e.g. by using exponential backoff in case of errors. | ||
* communicate that their tool/library is in no way sanctioned by Wube Software. | * communicate that their tool/library is in no way sanctioned by or associated with Wube Software. | ||
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal. | We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal. | ||
| Line 17: | Line 17: | ||
* Documentation will be kept up-to-date. | * Documentation will be kept up-to-date. | ||
* Breaking changes to these APIs are communicated in a reasonable timeframe. | * Breaking changes to these APIs are communicated in a reasonable timeframe. | ||
=== Experimental === | |||
* Short-lived, unstable APIs | |||
* For testing new features with the community | |||
== APIs == | == APIs == | ||
=== Internal === | === Internal === | ||
* | * [[Download API]] | ||
* | * [[Matchmaking API]] | ||
* | * [[Mod portal API]] | ||
* | * [[Web authentication API]] | ||
=== Public === | === Public === | ||
* [[Mod upload API]] | |||
* [[Mod details API ]] | |||
* [[Mod images API ]] | |||
* [[Mod publish API ]] | |||
=== Experimental === | |||
[[Category:Technical]] | [[Category:Technical]] | ||
Latest revision as of 15:30, 26 July 2022
General
Third party clients are welcome to use our HTTP APIs if they provide a benefit to players and creators in the Factorio community. We ask developers to:
- ensure user privacy, e.g. by properly securing account secrets like passwords, tokens or API keys.
- respect server resources, e.g. by using exponential backoff in case of errors.
- communicate that their tool/library is in no way sanctioned by or associated with Wube Software.
We reserve the right to ban or rate limit abusive clients, IP addresses or accounts. Unless stated otherwise, our APIs should be considered internal.
Categories
Internal
- These APIs are only supported for use with the official Factorio game clients or websites.
- Up-to-date documentation is not guaranteed.
- We strive to support very old Factorio releases, so these APIs won't change much most of the time.
Public
- These APIs are intended to support developers building integrations with the official Factorio game clients or websites.
- Documentation will be kept up-to-date.
- Breaking changes to these APIs are communicated in a reasonable timeframe.
Experimental
- Short-lived, unstable APIs
- For testing new features with the community