Riferimento API
Un'API di censimento in sola lettura. Tutto ciò che segue è una GET, e una chiave legge esattamente quello che legge una persona autenticata, niente di più.
Autenticazione
Invia la chiave in una delle due intestazioni. Nient'altro autentica una richiesta, e una chiave inviata a una rotta non elencata qui viene rifiutata anziché servita.
X-Api-Key: wos_YOUR_KEY
Oppure, come token bearer
Authorization: Bearer wos_YOUR_KEY
Avvio rapido
Sostituisci la chiave con la tua.
curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"
Endpoint
| Metodo | Percorso | Che cosa restituisce | Conta come |
|---|---|---|---|
| GET | /v1/alliances/{aid}/members | Recuperare un'Alleanza e il suo organico | Richiesta |
| GET | /v1/alliances/leaderboard | Ordinare le Alleanze per Potere totale | Richiesta |
| GET | /v1/alliances/recruiting | Elencare le Alleanze che accettano candidature | Richiesta |
| GET | /v1/alliances/search | Cercare Alleanze per sigla o per nome | Ricerca |
| GET | /v1/players/{uid} | Recuperare un Capo tramite lo uid interno | Richiesta |
| GET | /v1/players/search | Cercare Capi per nome o per identificativo | Ricerca |
Piani e limiti
Valori operativi attuali, non un diritto acquisito. Possono cambiare.
Ogni limite vale per account. Chiavi in più non comprano budget in più.
Entrambe le finestre di quota sono MOBILI, non periodi di calendario: la finestra di lettura guarda indietro trenta giorni da adesso e quella di ricerca ventiquattro ore. Quota e ricerca sono misurate per ACCOUNT, non per chiave — ogni chiave di un account attinge a un unico budget.
Intestazioni di risposta
Una risposta servita le porta tutte, e così un rifiuto per quota. Un rifiuto per picco porta solo le tre intestazioni con prefisso X-RateLimit, e una richiesta rifiutata prima della misurazione — 401 o 403 — non ne porta nessuna.
| Intestazione | Significato |
|---|---|
| X-Quota-Limit | La dotazione di letture dell'account per la finestra mobile di trenta giorni. |
| X-Quota-Remaining | Letture rimaste in quella finestra. |
| X-Quota-Reset | Secondi Unix in cui la lettura più vecchia esce dalla finestra. |
| X-Search-Limit | La dotazione di ricerche dell'account per la finestra mobile di ventiquattro ore. |
| X-Search-Remaining | Ricerche rimaste in quella finestra. |
| X-Search-Reset | Secondi Unix in cui la ricerca più vecchia esce dalla finestra. |
| X-RateLimit-Limit | La dotazione di picco dell'account per la finestra breve. |
| X-RateLimit-Remaining | Richieste rimaste nella finestra di picco. |
| X-RateLimit-Reset | Secondi Unix in cui la finestra di picco ruota. |
| Retry-After | Secondi da attendere prima di riprovare. Inviato su ogni 429 e specifico della finestra che ha rifiutato. |
Essere rifiutati
Tre cose diverse rispondono con un 429, e non sono intercambiabili.
| Codice di errore | Che cosa è successo |
|---|---|
| QUOTA_EXCEEDED | La quota di lettura mobile su trenta giorni dell'account è esaurita. `X-Quota-Remaining` segna zero; `X-Search-Remaining` resta onesto. |
| SEARCH_QUOTA_EXCEEDED | La quota di ricerca mobile su ventiquattro ore dell'account è esaurita. `X-Search-Remaining` segna zero; `X-Quota-Remaining` resta onesto. Solo le due rotte di ricerca vi incidono. |
| RATE_LIMIT_EXCEEDED | La breve finestra di picco dell'account è piena. `X-RateLimit-Remaining` segna zero. È un tetto su scala di secondi che si libera da solo; nessuna delle due finestre di quota è stata toccata. |
Codici di errore
| Codice | Stato | Significato |
|---|---|---|
| INVALID_API_KEY | 401 | La chiave è sconosciuta, revocata, oppure l'account a cui appartiene è stato eliminato. |
| ENDPOINT_NOT_ALLOWED | 403 | La rotta non fa parte della superficie per sviluppatori. Una chiave presentata su una rotta fuori da quella superficie viene rifiutata anziché servita, quindi non inviare una chiave a endpoint che questo documento non elenca. |
| QUOTA_EXCEEDED | 429 | La quota di lettura mobile su trenta giorni dell'account è esaurita. `X-Quota-Remaining` segna zero; `X-Search-Remaining` resta onesto. |
| SEARCH_QUOTA_EXCEEDED | 429 | La quota di ricerca mobile su ventiquattro ore dell'account è esaurita. `X-Search-Remaining` segna zero; `X-Quota-Remaining` resta onesto. Solo le due rotte di ricerca vi incidono. |
| RATE_LIMIT_EXCEEDED | 429 | La breve finestra di picco dell'account è piena. `X-RateLimit-Remaining` segna zero. È un tetto su scala di secondi che si libera da solo; nessuna delle due finestre di quota è stata toccata. |
Specifica leggibile dalla macchina
Il documento OpenAPI qui sotto è generato dal server in funzione ed è lo stesso che questa pagina rappresenta.