Dokumentacja API
API spisu wyłącznie do odczytu. Wszystko poniżej to GET, a klucz czyta dokładnie to, co czyta zalogowana osoba — nic więcej.
Uwierzytelnianie
Wyślij klucz w jednym z dwóch nagłówków. Nic innego nie uwierzytelnia zapytania, a klucz wysłany na trasę, której tu nie ma, zostaje odrzucony zamiast obsłużony.
X-Api-Key: wos_YOUR_KEY
Albo jako token okaziciela
Authorization: Bearer wos_YOUR_KEY
Szybki start
Podmień klucz na własny.
curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"
Punkty końcowe
| Metoda | Ścieżka | Co zwraca | Liczy się jako |
|---|---|---|---|
| GET | /v1/alliances/{aid}/members | Pobierz Sojusz wraz ze składem | Zapytanie |
| GET | /v1/alliances/leaderboard | Uszereguj Sojusze według łącznej Siły | Zapytanie |
| GET | /v1/alliances/recruiting | Wypisz Sojusze przyjmujące zgłoszenia | Zapytanie |
| GET | /v1/alliances/search | Szukaj Sojuszy po skrócie lub nazwie | Wyszukiwanie |
| GET | /v1/players/{uid} | Pobierz Szefa po wewnętrznym uid | Zapytanie |
| GET | /v1/players/search | Szukaj Szefów po nazwie lub identyfikatorze | Wyszukiwanie |
Plany i limity
Bieżące wartości robocze, a nie nabyte uprawnienie. Mogą się zmienić.
Każdy limit jest na konto. Dodatkowe klucze nie kupują dodatkowego budżetu.
Oba okna limitu są RUCHOME, a nie kalendarzowe: okno odczytów patrzy trzydzieści dni wstecz od teraz, a okno wyszukiwań dwadzieścia cztery godziny. Limit i wyszukiwanie mierzone są na KONTO, nie na klucz — każdy klucz konta czerpie z jednego budżetu.
Nagłówki odpowiedzi
Obsłużona odpowiedź niesie je wszystkie, tak samo odmowa z powodu limitu. Odmowa szczytowa niesie wyłącznie trzy nagłówki z przedrostkiem X-RateLimit, a zapytanie odrzucone przed pomiarem — 401 albo 403 — nie niesie żadnego.
| Nagłówek | Znaczenie |
|---|---|
| X-Quota-Limit | Przydział odczytów konta na ruchome okno trzydziestu dni. |
| X-Quota-Remaining | Odczyty pozostałe w tym oknie. |
| X-Quota-Reset | Sekundy uniksowe, w których najstarszy odczyt wypada z okna. |
| X-Search-Limit | Przydział wyszukiwań konta na ruchome okno dwudziestu czterech godzin. |
| X-Search-Remaining | Wyszukiwania pozostałe w tym oknie. |
| X-Search-Reset | Sekundy uniksowe, w których najstarsze wyszukiwanie wypada z okna. |
| X-RateLimit-Limit | Przydział szczytowy konta na krótkie okno. |
| X-RateLimit-Remaining | Zapytania pozostałe w oknie szczytowym. |
| X-RateLimit-Reset | Sekundy uniksowe, w których okno szczytowe się przewija. |
| Retry-After | Sekundy do odczekania przed ponowieniem. Wysyłany przy każdym 429 i właściwy dla okna, które odmówiło. |
Kiedy dostajesz odmowę
Trzy różne rzeczy odpowiadają kodem 429 i nie są wymienne.
| Kod błędu | Co się stało |
|---|---|
| QUOTA_EXCEEDED | Ruchomy trzydziestodniowy limit odczytów konta został wyczerpany. `X-Quota-Remaining` wskazuje zero; `X-Search-Remaining` pozostaje uczciwy. |
| SEARCH_QUOTA_EXCEEDED | Ruchomy dwudziestoczterogodzinny limit wyszukiwań konta został wyczerpany. `X-Search-Remaining` wskazuje zero; `X-Quota-Remaining` pozostaje uczciwy. Liczą się do niego tylko dwie trasy wyszukiwania. |
| RATE_LIMIT_EXCEEDED | Krótkie okno szczytowe konta jest pełne. `X-RateLimit-Remaining` wskazuje zero. To pułap w skali sekund, który zwalnia się sam; żadne okno limitu nie zostało naruszone. |
Kody błędów
| Kod | Status | Znaczenie |
|---|---|---|
| INVALID_API_KEY | 401 | Klucz jest nieznany, unieważniony albo konto, do którego należy, zostało usunięte. |
| ENDPOINT_NOT_ALLOWED | 403 | Trasa nie należy do powierzchni deweloperskiej. Klucz podany na trasie spoza tej powierzchni zostaje odrzucony zamiast obsłużony, więc nie wysyłaj klucza do punktów końcowych, których ten dokument nie wymienia. |
| QUOTA_EXCEEDED | 429 | Ruchomy trzydziestodniowy limit odczytów konta został wyczerpany. `X-Quota-Remaining` wskazuje zero; `X-Search-Remaining` pozostaje uczciwy. |
| SEARCH_QUOTA_EXCEEDED | 429 | Ruchomy dwudziestoczterogodzinny limit wyszukiwań konta został wyczerpany. `X-Search-Remaining` wskazuje zero; `X-Quota-Remaining` pozostaje uczciwy. Liczą się do niego tylko dwie trasy wyszukiwania. |
| RATE_LIMIT_EXCEEDED | 429 | Krótkie okno szczytowe konta jest pełne. `X-RateLimit-Remaining` wskazuje zero. To pułap w skali sekund, który zwalnia się sam; żadne okno limitu nie zostało naruszone. |
Specyfikacja czytelna dla maszyn
Dokument OpenAPI poniżej jest generowany z działającego serwera i jest tym samym, który przedstawia ta strona.