Référence de l'API
Une API de recensement en lecture seule. Tout ce qui suit est un GET, et une clé lit exactement ce que lit une personne connectée — rien de plus.
Authentification
Envoyez votre clé dans l'un ou l'autre en-tête. Rien d'autre n'authentifie une requête, et une clé envoyée vers une route absente de cette liste est refusée plutôt que servie.
X-Api-Key: wos_YOUR_KEY
Ou bien, en jeton porteur
Authorization: Bearer wos_YOUR_KEY
Démarrage rapide
Remplacez la clé par la vôtre.
curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"
Points d'accès
| Méthode | Chemin | Ce qu'il renvoie | Compte comme |
|---|---|---|---|
| GET | /v1/alliances/{aid}/members | Récupérer une Alliance et son effectif | Requête |
| GET | /v1/alliances/leaderboard | Classer les Alliances par Puissance totale | Requête |
| GET | /v1/alliances/recruiting | Lister les Alliances qui acceptent des candidatures | Requête |
| GET | /v1/alliances/search | Rechercher des Alliances par tag ou par nom | Recherche |
| GET | /v1/players/{uid} | Récupérer un Chef par son uid interne | Requête |
| GET | /v1/players/search | Rechercher des Chefs par nom ou par identifiant de Chef | Recherche |
Forfaits et limites
Valeurs d'exploitation actuelles, pas un droit acquis. Elles peuvent changer.
Chaque limite vaut par compte. Des clés supplémentaires n'achètent pas de budget supplémentaire.
Les deux fenêtres de quota sont GLISSANTES, et non des périodes calendaires : la fenêtre de lecture remonte trente jours en arrière et celle de recherche vingt-quatre heures. Le quota et la recherche se mesurent par COMPTE, pas par clé — toutes les clés d'un compte puisent dans un seul budget.
En-têtes de réponse
Une réponse servie les porte tous, et un refus de quota également. Un refus de pointe ne porte que les trois en-têtes préfixés X-RateLimit, et une requête refusée avant le décompte — 401 ou 403 — n'en porte aucun.
| En-tête | Signification |
|---|---|
| X-Quota-Limit | L'allocation de lecture du compte pour la fenêtre glissante de trente jours. |
| X-Quota-Remaining | Lectures restantes dans cette fenêtre. |
| X-Quota-Reset | Secondes Unix auxquelles la lecture la plus ancienne sort de la fenêtre. |
| X-Search-Limit | L'allocation de recherche du compte pour la fenêtre glissante de vingt-quatre heures. |
| X-Search-Remaining | Recherches restantes dans cette fenêtre. |
| X-Search-Reset | Secondes Unix auxquelles la recherche la plus ancienne sort de la fenêtre. |
| X-RateLimit-Limit | L'allocation de pointe du compte pour la fenêtre courte. |
| X-RateLimit-Remaining | Requêtes restantes dans la fenêtre de pointe. |
| X-RateLimit-Reset | Secondes Unix auxquelles la fenêtre de pointe bascule. |
| Retry-After | Secondes à attendre avant de réessayer. Envoyé sur chaque 429, et propre à la fenêtre qui a refusé. |
Être refusé
Trois choses différentes répondent par un 429, et elles ne sont pas interchangeables.
| Code d'erreur | Ce qui s'est passé |
|---|---|
| QUOTA_EXCEEDED | Le quota de lecture glissant sur trente jours du compte est épuisé. `X-Quota-Remaining` indique zéro ; `X-Search-Remaining` reste honnête. |
| SEARCH_QUOTA_EXCEEDED | Le quota de recherche glissant sur vingt-quatre heures du compte est épuisé. `X-Search-Remaining` indique zéro ; `X-Quota-Remaining` reste honnête. Seules les deux routes de recherche y sont décomptées. |
| RATE_LIMIT_EXCEEDED | La courte fenêtre de pointe du compte est pleine. `X-RateLimit-Remaining` indique zéro. C'est un plafond à l'échelle de la seconde qui se libère tout seul ; aucune des deux fenêtres de quota n'a été touchée. |
Codes d'erreur
| Code | Statut | Signification |
|---|---|---|
| INVALID_API_KEY | 401 | La clé est inconnue, révoquée, ou le compte auquel elle appartient a été supprimé. |
| ENDPOINT_NOT_ALLOWED | 403 | La route ne fait pas partie de la surface développeur. Une clé présentée sur une route hors de cette surface est refusée plutôt que servie : n'envoyez donc pas de clé vers des points d'accès que ce document ne liste pas. |
| QUOTA_EXCEEDED | 429 | Le quota de lecture glissant sur trente jours du compte est épuisé. `X-Quota-Remaining` indique zéro ; `X-Search-Remaining` reste honnête. |
| SEARCH_QUOTA_EXCEEDED | 429 | Le quota de recherche glissant sur vingt-quatre heures du compte est épuisé. `X-Search-Remaining` indique zéro ; `X-Quota-Remaining` reste honnête. Seules les deux routes de recherche y sont décomptées. |
| RATE_LIMIT_EXCEEDED | 429 | La courte fenêtre de pointe du compte est pleine. `X-RateLimit-Remaining` indique zéro. C'est un plafond à l'échelle de la seconde qui se libère tout seul ; aucune des deux fenêtres de quota n'a été touchée. |
Spécification lisible par machine
Le document OpenAPI ci-dessous est généré depuis le serveur en fonctionnement, et c'est celui-là même que cette page affiche.