Steam
POST/external/steamauth
Request an access token on behalf of a Steam user. To use this functionality you must add your games encrypted app ticket key from Steamworks, to the Game Admin > Settings page of your games profile on mod.io. A Successful request will return an Access Token Object.
NOTE: Steam is the only authentication endpoint that requires their token to be base64 encoded. All other endpoints tokens should be provided as a UTF-8 character string.
HINT: If you want to overlay the mod.io site in-game on Steam, we recommend you add ?portal=steam to the end of the URL you open which will prompt the user to login with Steam. See Web Overlay Authentication for details.
Request
Error Codes
| Status Code | Error Ref | Description |
|---|---|---|
| 401 | 11018 | The steam encrypted app ticket was invalid. |
| 401 | 11032 | mod.io was unable to verify the credentials against the external service provider. |
| 401 | 14001 | The game associated with the supplied api_key is currently not available. |
| 403 | 11016 | The api_key supplied in the request must be associated with a game. |
| 403 | 11017 | The api_key supplied in the request is for test environment purposes only and cannot be used for this functionality. |
| 403 | 11019 | The secret steam app ticket associated with this game has not been configured. |
| 403 | 11074 | The user has not agreed to the mod.io Terms of Use. Please see terms_agreed parameter description and the [Terms](/restapi/docs/terms) endpoint for more information. |
| 403 | 17053 | The user account associated with this email is locked. Please contact support for assistance. |
Responses
- 200
- 401
- 403
Successful Request
The game associated with the supplied api_key is currently not available.
The api_key supplied in the request must be associated with a game.