Referencia de la API
Una API de censo de solo lectura. Todo lo de abajo es un GET, y una clave lee exactamente lo que lee una persona con la sesión iniciada, nada más.
Autenticación
Envía tu clave en cualquiera de las dos cabeceras. Nada más autentica una petición, y una clave enviada a una ruta que no figure aquí se rechaza en lugar de servirse.
X-Api-Key: wos_YOUR_KEY
O bien, como token de portador
Authorization: Bearer wos_YOUR_KEY
Inicio rápido
Sustituye la clave por la tuya.
curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"
Endpoints
| Método | Ruta | Qué devuelve | Cuenta como |
|---|---|---|---|
| GET | /v1/alliances/{aid}/members | Obtener una Alianza y su plantilla | Petición |
| GET | /v1/alliances/leaderboard | Ordenar Alianzas por Poder total | Petición |
| GET | /v1/alliances/recruiting | Listar Alianzas que aceptan solicitudes | Petición |
| GET | /v1/alliances/search | Buscar Alianzas por etiqueta o por nombre | Búsqueda |
| GET | /v1/players/{uid} | Obtener un Gobernador por su uid interno | Petición |
| GET | /v1/players/search | Buscar Gobernadores por nombre o por identificador de Gobernador | Búsqueda |
Planes y límites
Valores de operación actuales, no un derecho adquirido. Pueden cambiar.
Cada límite es por cuenta. Las claves de más no compran presupuesto de más.
Ambas ventanas de cuota son MÓVILES, no periodos naturales: la ventana de lectura mira treinta días hacia atrás desde ahora y la de búsqueda veinticuatro horas. La cuota y la búsqueda se miden por CUENTA, no por clave: todas las claves que tenga una cuenta beben de un único presupuesto.
Cabeceras de respuesta
Una respuesta servida las lleva todas, y un rechazo por cuota también. Un rechazo por pico lleva solo las tres cabeceras con el prefijo X-RateLimit, y una petición rechazada antes de medirse — 401 o 403 — no lleva ninguna.
| Cabecera | Significado |
|---|---|
| X-Quota-Limit | La asignación de lecturas de la cuenta para la ventana móvil de treinta días. |
| X-Quota-Remaining | Lecturas que quedan en esa ventana. |
| X-Quota-Reset | Segundos Unix en los que la lectura más antigua sale de la ventana. |
| X-Search-Limit | La asignación de búsquedas de la cuenta para la ventana móvil de veinticuatro horas. |
| X-Search-Remaining | Búsquedas que quedan en esa ventana. |
| X-Search-Reset | Segundos Unix en los que la búsqueda más antigua sale de la ventana. |
| X-RateLimit-Limit | La asignación de pico de la cuenta para la ventana corta. |
| X-RateLimit-Remaining | Peticiones que quedan en la ventana de pico. |
| X-RateLimit-Reset | Segundos Unix en los que la ventana de pico rota. |
| Retry-After | Segundos que esperar antes de reintentar. Se envía en cada 429 y es propio de la ventana que denegó. |
Que te rechacen
Tres cosas distintas responden con un 429, y no son intercambiables.
| Código de error | Qué ha pasado |
|---|---|
| QUOTA_EXCEEDED | La cuota de lectura móvil de treinta días de la cuenta está agotada. `X-Quota-Remaining` marca cero; `X-Search-Remaining` sigue siendo honesto. |
| SEARCH_QUOTA_EXCEEDED | La cuota de búsqueda móvil de veinticuatro horas de la cuenta está agotada. `X-Search-Remaining` marca cero; `X-Quota-Remaining` sigue siendo honesto. Solo las dos rutas de búsqueda cuentan contra ella. |
| RATE_LIMIT_EXCEEDED | La ventana corta de pico de la cuenta está llena. `X-RateLimit-Remaining` marca cero. Es un techo a escala de segundos que se despeja solo; ninguna ventana de cuota se ha tocado. |
Códigos de error
| Código | Estado | Significado |
|---|---|---|
| INVALID_API_KEY | 401 | La clave es desconocida, está revocada, o la cuenta a la que pertenece ha sido eliminada. |
| ENDPOINT_NOT_ALLOWED | 403 | La ruta no está en la superficie de desarrollador. Una clave presentada en una ruta fuera de esa superficie se rechaza en lugar de servirse, así que no envíes una clave a endpoints que este documento no enumere. |
| QUOTA_EXCEEDED | 429 | La cuota de lectura móvil de treinta días de la cuenta está agotada. `X-Quota-Remaining` marca cero; `X-Search-Remaining` sigue siendo honesto. |
| SEARCH_QUOTA_EXCEEDED | 429 | La cuota de búsqueda móvil de veinticuatro horas de la cuenta está agotada. `X-Search-Remaining` marca cero; `X-Quota-Remaining` sigue siendo honesto. Solo las dos rutas de búsqueda cuentan contra ella. |
| RATE_LIMIT_EXCEEDED | 429 | La ventana corta de pico de la cuenta está llena. `X-RateLimit-Remaining` marca cero. Es un techo a escala de segundos que se despeja solo; ninguna ventana de cuota se ha tocado. |
Especificación legible por máquina
El documento OpenAPI de abajo se genera desde el servidor en funcionamiento y es el mismo que representa esta página.