Az AchStats rendelkezik RESTful API-val, mely hasonló a Steam Web API-jához. Az összegyűjtött adatok elérhetők az érdeklődő fejlesztők számára, és ily módon le is kérhetik őket. A használathoz szükség van egy hozzáférési kulcsra, melyet itt igényelhetsz. Alább megtalálható a dokumentáció az összes funkcióról.
A hozzáférési kulcsok titkosak, és e-mail címhez kötöttek. Kérjük, alább add meg az e-mail címedet, hogy kapj egy 25 számjegyű kódot. Abban az esetben, ha elveszted, akkor ugyanígy kaphatsz újat.
A hozzáférési kulcsok visszavonhatók hosszabb inaktivitás, vagy nagy mennyiségű kérés miatt. Ebben az esetben tájékoztatva leszel. Ezenfelül bármikor saját magad is törölheted a kulcsodat.
Minden hívás a api.achievementstats.com/ és api.achstats.com/ URL-en keresztül, és a további terminológia feltérképezésével történik. Az URL-nek mindig a megadott 25 számjegyű hozzáférési kulccsal kell végződnie, ebben az alakban: „/?key=…”.
A válasz mindig JSON formátumban van. Az érvénytelen hozzáférési kódú hívások eredménye 403-as HTTP státuszkód, és az ismeretlen hívás eredménye 404-es HTTP státuszkód.
| URL-rész | Metódus | Magyarázat | Példa |
|---|---|---|---|
| profiles/<Steam64ID>/ | GET | Profiladat a megadott Steam64ID-val. | profiles/76561197968240913/ |
| profiles/<Steam64ID>/games/ | GET | Egy profil birtokolt játékai AppID-kként a megadott Steam64ID-val. | profiles/76561197968240913/games/ |
| profiles/<Steam64ID>/achievements/ | GET | Egy profil feloldott teljesítményei API névként, és az AppID-jük a megadott Steam64ID-val. Opcionális „appIds” paramétert használ bizonyos játékok szűrésére. | |
| profiles/<Steam64ID>/friends/ | GET | Egy profil barátai Steam64ID-kként a megadott Steam64ID-val. | profiles/76561197968240913/friends/ |
| profiles/<Steam64ID>/badges/ | GET | Egy profil feloldott kitűzői BadgeID-val a megadott Steam64ID-val. | profiles/76561197968240913/badges/ |
| profiles/<Steam64ID>/update/ | POST | Profilfrissítést indít a megadott Steam64ID-val. | profiles/76561197968240913/update/ |
| games/ | GET | Elérhető játékok listája AppID-kként. | games/ |
| games/<AppID>/ | GET | Egy játék adatai a megadott AppID-val. Ez szintén vonatkozik a DLC-kre, azonban a külső DLC-knek (nem elérhetők a Steamen) negatív AppID-jük van. | |
| games/<AppID>/achievements/ | GET | Egy játék vagy DLC teljesítményei a megadott AppID-val. | games/1250/achievements/ |
| games/<AppID>/badges/ | GET | Egy játék kitűzői a megadott AppID-val. | games/1250/badges/ |
| games/<AppID>/dlcs/ | GET | Egy játék DLC-i AppID-kként a megadott AppID-val. | games/1250/dlcs/ |
| badges/ | GET | Elérhető kitűzők listája BadgeID-kként és AppID-kként. | badges/ |
| badges/<BadgeID>/ | GET | Egy kitűző adatai a megadott BadgeID-val, nem kapcsolódik a játékkártyákhoz. | badges/1/ |
| badges/<BadgeID>/stages/ | GET | Egy kitűző szakaszai a megadott BadgeID-val. | badges/1/stages/ |