Szybki start

Zdobądź swoje Steam ID i klucz API

Żeby zacząć korzystać z SteamApis, zaloguj się swoim kontem Steam. Po zalogowaniu przejdź do strony ustawień SteamApis, żeby pobrać swoje SteamID64 i klucz API. Klucz API jest niezbędny do korzystania ze wszystkich endpointów API.

Uwierzytelnianie

W v2 klucz API musi być przekazywany przez header x-api-key. Jako fallback możesz również przekazać go jako query parameter key.

const API_KEY = '1nqNbqP5JYQ9Lpw5nATfKumaxN0';

const response = await fetch('https://api.steamapis.com/v2/steam/users/76561198038526790', {
  headers: {
    'x-api-key': API_KEY
  }
});

const data = await response.json();
console.log(data);

Format odpowiedzi

Wszystkie endpointy v2 zwracają odpowiedzi w standardowym formacie envelope:

Odpowiedź sukcesu:

{
  "success": true,
  "response": {
    // dane specyficzne dla endpointu
  }
}

Odpowiedź błędu:

{
  "success": false,
  "error": {
    "name": "BadRequestError",
    "message": "NOT_FOUND",
    "meta": null
  }
}

Kody statusu HTTP

Wszystkie odpowiedzi API są zwracane w formacie JSON. Sprawdź kod statusu HTTP, żeby ustalić, czy twoje zapytanie zakończyło się sukcesem:

• 200 OK - zapytanie zakończyło się sukcesem.
• 400 Bad Request - zapytanie nie mogło zostać zrozumiane lub brakowało wymaganych parametrów.
• 401 Unauthorized - brakujący lub nieprawidłowy klucz API.
• 403 Forbidden - dostęp zabroniony. Twoje konto może nie mieć wystarczającego salda lub uprawnień.
• 404 Not Found - żądany zasób nie został znaleziony.
• 429 Too Many Requests - przekroczony limit zapytań.
• 500 Internal Server Error - coś poszło nie tak po naszej stronie.

Kody błędów

Kiedy zapytanie zakończy się niepowodzeniem, odpowiedź błędu zawiera pole message, które pomaga zidentyfikować problem: