API başvurusu
Yalnızca okuma yapan bir sayım API'si. Aşağıdakilerin tamamı GET'tir ve bir anahtar, oturum açmış bir kişinin okuduğunun tam olarak aynısını okur — fazlasını değil.
Kimlik doğrulama
Anahtarınızı iki başlıktan birinde gönderin. Bir isteği başka hiçbir şey doğrulamaz ve burada listelenmeyen bir yola gönderilen anahtar karşılanmak yerine reddedilir.
X-Api-Key: wos_YOUR_KEY
Ya da taşıyıcı belirteci olarak
Authorization: Bearer wos_YOUR_KEY
Hızlı başlangıç
Anahtarı kendi anahtarınızla değiştirin.
curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"
Uç noktalar
| Yöntem | Yol | Ne döndürür | Şu sayılır |
|---|---|---|---|
| GET | /v1/alliances/{aid}/members | Bir İttifakı ve kadrosunu getir | İstek |
| GET | /v1/alliances/leaderboard | İttifakları toplam Güce göre sırala | İstek |
| GET | /v1/alliances/recruiting | Başvuru kabul eden İttifakları listele | İstek |
| GET | /v1/alliances/search | İttifakları etiketine veya adına göre ara | Arama |
| GET | /v1/players/{uid} | Bir Şefi dahili uid ile getir | İstek |
| GET | /v1/players/search | Şefleri adına veya Şef kimliğine göre ara | Arama |
Planlar ve sınırlar
Güncel işletme değerleri, kazanılmış bir hak değil. Değişebilirler.
Her sınır hesap başınadır. Fazladan anahtar fazladan bütçe satın almaz.
Her iki kota penceresi de takvim dönemi değil KAYAN penceredir: okuma penceresi şu andan geriye otuz gün, arama penceresi yirmi dört saat bakar. Kota ve arama anahtar başına değil HESAP başına ölçülür — bir hesabın tuttuğu her anahtar tek bir bütçeden harcar.
Yanıt başlıkları
Karşılanan bir yanıt bunların hepsini taşır, kota reddi de öyle. Ani yük reddi yalnızca X-RateLimit önekli üç başlığı taşır; ölçümden önce reddedilen bir istek — 401 ya da 403 — hiçbirini taşımaz.
| Başlık | Anlamı |
|---|---|
| X-Quota-Limit | Hesabın kayan otuz günlük pencere için okuma payı. |
| X-Quota-Remaining | O pencerede kalan okumalar. |
| X-Quota-Reset | En eski okumanın pencereden düştüğü Unix saniyesi. |
| X-Search-Limit | Hesabın kayan yirmi dört saatlik pencere için arama payı. |
| X-Search-Remaining | O pencerede kalan aramalar. |
| X-Search-Reset | En eski aramanın pencereden düştüğü Unix saniyesi. |
| X-RateLimit-Limit | Hesabın kısa pencere için ani yük payı. |
| X-RateLimit-Remaining | Ani yük penceresinde kalan istekler. |
| X-RateLimit-Reset | Ani yük penceresinin döndüğü Unix saniyesi. |
| Retry-After | Yeniden denemeden önce beklenecek saniye. Her 429 ile gönderilir ve reddeden pencereye özgüdür. |
Reddedilmek
429 ile yanıt veren üç ayrı durum vardır ve birbirlerinin yerine geçmezler.
| Hata kodu | Ne oldu |
|---|---|
| QUOTA_EXCEEDED | Hesabın kayan otuz günlük okuma kotası tükendi. `X-Quota-Remaining` sıfır gösterir; `X-Search-Remaining` dürüst kalır. |
| SEARCH_QUOTA_EXCEEDED | Hesabın kayan yirmi dört saatlik arama kotası tükendi. `X-Search-Remaining` sıfır gösterir; `X-Quota-Remaining` dürüst kalır. Buna yalnızca iki arama yolu sayılır. |
| RATE_LIMIT_EXCEEDED | Hesabın kısa ani yük penceresi dolu. `X-RateLimit-Remaining` sıfır gösterir. Bu, saniye ölçeğinde bir tavandır ve kendiliğinden açılır; hiçbir kota penceresine dokunulmamıştır. |
Hata kodları
| Kod | Durum | Anlamı |
|---|---|---|
| INVALID_API_KEY | 401 | Anahtar tanınmıyor, iptal edilmiş, ya da sahibi olan hesap silinmiş. |
| ENDPOINT_NOT_ALLOWED | 403 | Yol, geliştirici yüzeyinde değil. Bu yüzeyin dışındaki bir yolda sunulan anahtar karşılanmak yerine reddedilir; bu nedenle bu belgenin listelemediği uç noktalara anahtar göndermeyin. |
| QUOTA_EXCEEDED | 429 | Hesabın kayan otuz günlük okuma kotası tükendi. `X-Quota-Remaining` sıfır gösterir; `X-Search-Remaining` dürüst kalır. |
| SEARCH_QUOTA_EXCEEDED | 429 | Hesabın kayan yirmi dört saatlik arama kotası tükendi. `X-Search-Remaining` sıfır gösterir; `X-Quota-Remaining` dürüst kalır. Buna yalnızca iki arama yolu sayılır. |
| RATE_LIMIT_EXCEEDED | 429 | Hesabın kısa ani yük penceresi dolu. `X-RateLimit-Remaining` sıfır gösterir. Bu, saniye ölçeğinde bir tavandır ve kendiliğinden açılır; hiçbir kota penceresine dokunulmamıştır. |
Makine okuyabilir şartname
Aşağıdaki OpenAPI belgesi çalışan sunucudan üretilir ve bu sayfanın gösterdiğiyle aynıdır.