ePrison Web API Documentation

Settings

Get your key here Your WebAPI Key

Preferred Output Format

Get your id here Pre-fill SteamID

What is this?

Description

Using the API

The public Steamworks Web API is hosted on https://api.steampowered.com or https://community.steam-api.com.

The public Web API host is accessible via HTTP (port 80) and HTTPS (port 443). Note that any requests using your publisher Web API key should be made over HTTPS.
This service is behind Akamai's edge cache, so the actual IP addresses you will see for the name will vary based on your location and on ongoing service changes.
The IPs can change rapidly and fluidly, so if your Web API calls are made through a firewall on outbound requests, read on.

Steam also provides a partner-only Web API server hosted on https://partner.steam-api.com. The intent of this service is to have higher availability than the public host; you should use this service for all requests made from your secure servers. This host has some different properties than the public host:

This host is only accessible via HTTPS.
This host is not behind Akamai's edge cache.
Every request to this host must be made with your publisher Web API key, even requests which would ordinarily not need a key.
Requests made without a valid publisher key will return a 403 error code.
Requests generating 403 status codes will incur strict rate limits for the connecting IP. This is in an effort to ensure high availability. If you generate a sufficient number of requests within a certain time interval that return 403 status codes — either during testing, or by using a regular Web API key instead of your publisher key — the host will put your IP on a deny list for a while.

You should not connect to the Web API servers by IP; use the DNS name.

Requests and responses

Similiar to the Steamworks C++ API, the Web API has been divided into multiple interfaces that contain related methods. The URI format of each API request is: https://api.steampowered.com/<interface>/<method>/<method_version>/

Steam supports returning Web API responses in multiple formats. By default, all responses are returned JSON encoded. However, each request can optionally contain a format parameter to specify the desired response format. The following values can be passed for this parameter: xml, json, and vdf.

A flexible solution should be used to parse Web API results as each method may return results in an arbitrary order.

License

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Sitemap