Başlarken

Hızlı başlangıç

API anahtarını alarak ve ilk API isteğini yaparak SteamApis v2'ye başla.

Steam ID ve API anahtarını al

SteamApis'i kullanmaya başlamak için Steam hesabınla giriş yap. Giriş yaptıktan sonra SteamApis Ayarlar sayfasına git ve SteamID64'ünü ve API anahtarını al. API anahtarı, tüm API endpointlerine erişmek için gereklidir.

Bir SteamID arama aracı olan SteamID ile Steam ID'ni bul.
SteamApis hesabından API Anahtarını al.

Kimlik doğrulama

v2'de API anahtarın x-api-key request header'ı üzerinden gönderilmelidir. Yedek olarak, key query parameter olarak da gönderebilirsin.

index.js
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);

Yanıt formatı

Tüm v2 endpoint'leri yanıtları standart bir envelope formatında döndürür:

Başarılı yanıt:

response.json
{
  "success": true,
  "response": {
    // endpoint'e özgü veri
  }
}

Hata yanıtı:

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

HTTP durum kodları

Tüm API yanıtları JSON formatında döner. İsteğinin başarılı olup olmadığını kontrol etmek için HTTP durum koduna bak:

  • 200 OK - istek başarılı.
  • 400 Bad Request - istek anlaşılamadı veya gerekli parametreler eksikti.
  • 401 Unauthorized - API anahtarı eksik veya geçersiz.
  • 403 Forbidden - erişim engellendi. Hesabında yeterli bakiye veya izin olmayabilir.
  • 404 Not Found - istenen kaynak bulunamadı.
  • 429 Too Many Requests - rate limit aşıldı.
  • 500 Internal Server Error - bizim tarafta bir şeyler ters gitti.

Hata kodları

Bir istek başarısız olduğunda, hata yanıtı sorunu belirlemeye yardımcı olacak bir message alanı içerir:

MesajHTTP DurumuAçıklama
MISSING_API_KEY403Request header'da veya query parameter'da API anahtarı sağlanmamış
INVALID_API_KEY403Sağlanan API anahtarı geçerli değil
ACCESS_DENIED403API anahtarın devre dışı bırakılmış
INSUFFICIENT_BALANCE400Ücretsiz katman limitine ulaşıldı veya hesapta bakiye yok
NOT_FOUND400İstenen kaynak bulunamadı
INVALID_PARAMS400Geçersiz veya hatalı parametreler
INTERNAL_ERROR500Bizim tarafta bir şeyler ters gitti
Tüm durum kodlarının tam dokümantasyonunu WebFX'te bulabilirsin