AchStats, Steam Web API'sine benzer bir RESTful API'ye sahiptir. Toplanan veriler, ilgilenen geliştiricilerin bu yolla edinilebilmesi için kullanılabilir duruma getirilir. Kullanım, burada talep edilebilen bir erişim anahtarı gerektirir. Tüm özelliklerin bir dokümanı aşağıda bulunabilir.
Erişim anahtarları gizlidir ve e-posta adreslerine bağlanır. Lütfen 25 basamaklı bir anahtar almak için e-posta adresinizi girin. Kaybettiyseniz, aynı şekilde tekrar alabilirsiniz.
Erişim anahtarı, uzun süre hareketsizlik veya büyük talepler nedeniyle iptal edilebilir. Bu durumda size haber verilecektir. Ayrıca anahtarınızı istediğiniz zaman kendi başınıza da silebilirsiniz.
Tüm çağırımlar api.achievementstats.com/ veya api.achstats.com/ URL'sine yapılır. URL her zaman "/?key=…" şeklinde 25 haneli erişim anahtarını içermelidir.
Yanıt her zaman JSON formatındadır. Geçersiz erişim tuşuyla yapılan çağrılar 403 HTTP durum koduyla sonuçlanır ve bilinmeyen çağrılar 404 HTTP durum koduyla sonuçlanır.
| URL Bölümü | Yöntem | Açıklama | Örnek |
|---|---|---|---|
| profiles/<Steam64ID>/ | GET | Belirtilen Steam64ID ile bir profil verisi. | profiles/76561197968240913/ |
| profiles/<Steam64ID>/games/ | GET | Belirtilen Steam64ID ile bir profilin sahip olduğu oyunların AppID'si. | profiles/76561197968240913/games/ |
| profiles/<Steam64ID>/achievements/ | GET | API adı ve belirtilen Steam64ID ile bir profilin AppID'sinin açılmış başarıları. Sadece belirli oyunlar için bir filtre olarak isteğe bağlı "appIds" parametresini kullanır. | |
| profiles/<Steam64ID>/friends/ | GET | Belirtilen Steam64ID ile bir profilin Steam64ID'si olarak arkadaşlar. | profiles/76561197968240913/friends/ |
| profiles/<Steam64ID>/badges/ | GET | Belirtilen Steam64ID'ye sahip bir profilin BadgeID'si ile açılan rozetler. | profiles/76561197968240913/badges/ |
| profiles/<Steam64ID>/update/ | POST | Belirtilen Steam64ID ile bir profilin güncellemesini tetikler. | profiles/76561197968240913/update/ |
| games/ | GET | AppID'ler olarak mevcut oyunların listesi. | games/ |
| games/<AppID>/ | GET | Belirtilen AppID değerine sahip bir oyunun verileri. Bu, DLC'ler için de geçerlidir, ancak harici DLC'ler (Steam'de mevcut değil) negatif AppID'lere sahiptir. | |
| games/<AppID>/achievements/ | GET | Belirtilen AppID ile bir oyunun veya DLC'nin başarımları. | games/1250/achievements/ |
| games/<AppID>/badges/ | GET | Belirtilen AppID ile bir oyunun rozetleri. | games/1250/badges/ |
| games/<AppID>/dlcs/ | GET | Belirtilen AppID ile bir oyunun AppID'si olarak DLC. | games/1250/dlcs/ |
| badges/ | GET | BadgeID'ler ve AppID'ler olarak uygun rozetlerin listesi. | badges/ |
| badges/<BadgeID>/ | GET | Oyun kartları ile ilişkili olmayan, belirtilen BadgeID kartına sahip bir rozetin verisi. | badges/1/ |
| badges/<BadgeID>/stages/ | GET | Belirtilen Rozet Kimliği ile bir rozetin aşamaları. | badges/1/stages/ |