SteamAuth.md

Steam players authorization

With RustApi you can build full featured REST API server based on your regular Plugin for your external solution, like mobile application or web site.

But you also will be need to authorize players somehow, so RestApi provides this functions to identify and verify users via Steam Login page.

How to login (for mobile application example)

• Open your mobile application
• Open page with in-app browser: http://your-configured-endpoint/auth/login
• Player will be redirected to regular Steam login page
• Player should login on steam platform (only steam will see player credentials)
• After finishing, browser will be redirected to callback url
• Handle callback url in your in-app browser to extract RustApi credentials (name and secret)

Steam login page

On opening /auth/login page, RustApi will build correct url for Steam Login page and redirect player to it.

Callback url

By default, when player logged in, he/she will be redirected to /auth/steamId?name={name}&secret={secret}. In mobile application you can handle this url and extract name and secret values from url.

Then you can use this credentials for regular calls of RustApi.
Read more how to connect with credentials.

Custom callback url

To specify custom callback url, set callback parameter on login (e.g. http://your-configured-endpoint/auth/login?callback=http://my-service.com/verify).

When player logged, he will be redirected to http://my-service.com/verify?name={name}&secret={secret}