GAMEMONITORING API
GAMEMONITORING REST API sunucular, oyuncular, gönderiler, çevrimiçi geçmişi ve oylar hakkında JSON verileri döndürür. Bu sayfa entegrasyonun temellerini ve ilk isteği açıklar. Parametreler ve istek testleri yöntem sayfalarında bulunur.
API sürümleri
API sürümünü isteğe bağlı v sorgu parametresiyle seçebilirsiniz. Geçerli sürüm 1.0.0. Sürüm kullanılabilir yolları, istek alanlarını ve yanıt biçimini belirler.
v belirtilmezse desteklenen en düşük sürüm kullanılır. Bu sürüm kaldırıldığında bir sonraki en düşük sürüm varsayılan olur. Sözleşmeyi sabitlemek için v belirtin. Geçersiz, tekrarlanan veya desteklenmeyen sürümler HTTP 400 döndürür; desteklenmeyen sürümler için kullanılabilir değerler error.data.supported_versions alanındadır.
Yöntem seçin
Yöntem sayfasında zorunlu parametreler, yanıt şemaları, farklı diller için örnekler ve istek testi bulunur. Sunucu eklemek gerçek bir işlem gerçekleştirir; herkese açık okuma yöntemleri veri döndürür.
Bağlantı adresiyle sunucu ekler veya mevcut sunucuyu döndürür.
Sunucunun herkese açık verilerini döndürür.
Sunucunun oyuncu listesini döndürür.
Belirtilen sunucudan görünür biçimde bahseden herkese açık gönderileri döndürür.
Her aralığın en düşük, ortalama ve en yüksek oyuncu sayısını içeren grafiği döndürür.
Belirtilen sunucuya verilen oyları döndürür.
Günlük oy sayılarını döndürür.
En fazla oy veren kullanıcıları döndürür.
Her aralık için proje sunucularındaki toplam oyuncu sayısının en düşük, ortalama ve en yüksek değerlerini döndürür.
Projeye verilen oyları döndürür. Kimlik doğrulaması olmadan yalnızca herkese açık projelere erişilebilir.
Projenin günlük oy sayılarını döndürür. Kimlik doğrulaması olmadan yalnızca herkese açık projelere erişilebilir.
Projeye en çok oy veren kullanıcıları döndürür. Kimlik doğrulaması olmadan yalnızca herkese açık projelere erişilebilir.
Kimliğine göre oy bilgilerini döndürür.
Oyu işlenmiş olarak işaretler. Sunucu veya proje sahibi tarafından kullanılabilir.
Kullanıcı profili verilerini döndürür.
Kullanıcı, GAMEMONITORING hesabının kendisine ait olduğunu doğrulamak için Entegrasyon bölümünden bir kod alır. Kod oluşturulduktan sonra 5 dakika geçerlidir. Doğrulama başarılı olursa API, kodun verildiği hesabın kimliğini döndürür ve kodu kullanılmış olarak işaretler.
Parametreleri gönderme
- URL parametreleri
- Kimlikler istek yolundadır: server_id ve project_id sayısal GAMEMONITORING kimlikleri, vote_id ise oy kimliğidir. Süslü parantez içindeki parametreyi gerçek değeriyle değiştirin.
- Sorgu parametreleri
- Filtreler, dönemler ve sayfalama URL içinde ? sonrasında gönderilir. Özellikle takma ad ve arama metnini URLSearchParams veya kullandığınız kütüphanenin eşdeğeriyle kodlayın.
- Gövde parametreleri
- Sunucu eklemek için Content-Type: application/json ile JSON gönderin. connect herkese açık host:port, steam_app_id oyunun Steam App ID değeridir. Sorgu ve bağlantı portları farklıysa query kullanın.
Veri biçimi
HTTP 200 sonucu response içinde döndürür: yönteme göre nesne, dizi veya items içeren nesne. Yöntemin şemasına bakın; boş liste tek başına hata değildir.
Bazı alanlar null olabilir veya bulunmayabilir. Bunlar 0, false ve boş metinden farklıdır; eksik veriyi ayrı ele alın.
created_at, expires_at ve last_update saniye cinsinden Unix zamanı kullanır. JavaScript Date için 1000 ile çarpın; filtrelerde Date.now() değerini 1000 ile bölüp aşağı yuvarlayın.
64 bit Steam kimliklerini metin olarak saklayın. JavaScript Number dönüşümü hassasiyet kaybına yol açabilir. GAMEMONITORING sunucu kimliği ile oyunun Steam App ID değeri farklı kimliklerdir.
Hatalar ve yeniden denemeler
HTTP durumunu ve error nesnesini kontrol edin: code durum kodunu, message açıklamayı, data varsa ek bilgileri içerir. Mesaj metni bölgeye göre değişebilir; kodda koşul olarak kullanmayın.
- 400
- Geçersiz parametreler veya JSON. Türleri, zorunlu alanları ve izin verilen değerleri kontrol edin.
- 403
- Erişim reddedildi: adres engellenmiş veya proje herkese açık değil.
- 404
- İstenen kaynak mevcut değil.
- 405
- HTTP yöntemini ve yolu kontrol edin; bu işlem desteklenmiyor.
- 429
- Bekleyin ve erişilebiliyorsa Retry-After başlığını dikkate alın. Aynı isteği hemen tekrarlamak sınırı kaldırmaz.
- 500 / 503 / 504
- Geçici okuma hatalarını artan bekleme süresiyle sınırlı sayıda tekrar deneyin. Sunucu ekleme zaman aşımında önce sonucu kontrol edin; istek tamamlanmış olabilir.
Parametre veya erişim hatasının nedenini düzeltmeden tekrar denemeyin. JSON içermeyebilen ağ hatalarını ve proxy yanıtlarını da ele alın.
Veriler son sunucu sorgusunu yansıtır ve önbellekte olabilir. last_update değerini kontrol edin, makul bir yenileme aralığı kullanın ve sonucu entegrasyonunuzda önbelleğe alın. API sorgularını sıklaştırmak oyun sunucusunu daha hızlı güncellemez.
Oylama ve Webhook
Yeni oylara tepki vermek için proje Webhook ayarını yapın. signature değerini doğrulayın, is_test=true testlerini atlayın ve oyu API üzerinden almak için event_id değerini vote_id olarak kullanın. entity_type ve entity_id değerlerini kontrol edin ve event_type + event_id çiftini yalnızca bir kez işleyin. Test olaylarını ödül vermeden 2xx yanıtıyla onaylayın.