Referência da API
Uma API de censo somente de leitura. Tudo abaixo é um GET, e uma chave lê exatamente o que uma pessoa autenticada lê — nada além.
Autenticação
Envie sua chave em qualquer um dos dois cabeçalhos. Nada mais autentica uma requisição, e uma chave enviada a uma rota que não esteja listada aqui é recusada em vez de atendida.
X-Api-Key: wos_YOUR_KEY
Ou, como token portador
Authorization: Bearer wos_YOUR_KEY
Início rápido
Substitua a chave pela sua.
curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"
Endpoints
| Método | Caminho | O que retorna | Conta como |
|---|---|---|---|
| GET | /v1/alliances/{aid}/members | Obter uma Aliança e seu elenco | Requisição |
| GET | /v1/alliances/leaderboard | Ordenar Alianças por Poder total | Requisição |
| GET | /v1/alliances/recruiting | Listar Alianças que aceitam candidaturas | Requisição |
| GET | /v1/alliances/search | Buscar Alianças por sigla ou nome | Busca |
| GET | /v1/players/{uid} | Obter um Chefe pelo uid interno | Requisição |
| GET | /v1/players/search | Buscar Chefes por nome ou identificador de Chefe | Busca |
Planos e limites
Valores operacionais atuais, não um direito adquirido. Podem mudar.
Todo limite é por conta. Chaves a mais não compram orçamento a mais.
As duas janelas de cota são MÓVEIS, não períodos de calendário: a janela de leitura olha trinta dias para trás a partir de agora e a de busca, vinte e quatro horas. Cota e busca são medidas por CONTA, não por chave — toda chave que uma conta tem bebe de um único orçamento.
Cabeçalhos de resposta
Uma resposta atendida carrega todos eles, e uma recusa por cota também. Uma recusa por pico carrega apenas os três cabeçalhos com o prefixo X-RateLimit, e uma requisição recusada antes da medição — 401 ou 403 — não carrega nenhum.
| Cabeçalho | Significado |
|---|---|
| X-Quota-Limit | A franquia de leituras da conta para a janela móvel de trinta dias. |
| X-Quota-Remaining | Leituras restantes nessa janela. |
| X-Quota-Reset | Segundos Unix em que a leitura mais antiga sai da janela. |
| X-Search-Limit | A franquia de buscas da conta para a janela móvel de vinte e quatro horas. |
| X-Search-Remaining | Buscas restantes nessa janela. |
| X-Search-Reset | Segundos Unix em que a busca mais antiga sai da janela. |
| X-RateLimit-Limit | A franquia de pico da conta para a janela curta. |
| X-RateLimit-Remaining | Requisições restantes na janela de pico. |
| X-RateLimit-Reset | Segundos Unix em que a janela de pico vira. |
| Retry-After | Segundos a esperar antes de tentar de novo. Enviado em todo 429, e específico da janela que recusou. |
Ser recusado
Três coisas diferentes respondem com um 429, e elas não são intercambiáveis.
| Código de erro | O que aconteceu |
|---|---|
| QUOTA_EXCEEDED | A cota de leitura móvel de trinta dias da conta acabou. `X-Quota-Remaining` marca zero; `X-Search-Remaining` continua honesto. |
| SEARCH_QUOTA_EXCEEDED | A cota de busca móvel de vinte e quatro horas da conta acabou. `X-Search-Remaining` marca zero; `X-Quota-Remaining` continua honesto. Só as duas rotas de busca contam contra ela. |
| RATE_LIMIT_EXCEEDED | A janela curta de pico da conta está cheia. `X-RateLimit-Remaining` marca zero. É um teto na escala de segundos que se libera sozinho; nenhuma das janelas de cota foi tocada. |
Códigos de erro
| Código | Status | Significado |
|---|---|---|
| INVALID_API_KEY | 401 | A chave é desconhecida, foi revogada, ou a conta dona dela foi excluída. |
| ENDPOINT_NOT_ALLOWED | 403 | A rota não está na superfície de desenvolvedor. Uma chave apresentada numa rota fora dessa superfície é recusada em vez de atendida, então não envie chave para endpoints que este documento não lista. |
| QUOTA_EXCEEDED | 429 | A cota de leitura móvel de trinta dias da conta acabou. `X-Quota-Remaining` marca zero; `X-Search-Remaining` continua honesto. |
| SEARCH_QUOTA_EXCEEDED | 429 | A cota de busca móvel de vinte e quatro horas da conta acabou. `X-Search-Remaining` marca zero; `X-Quota-Remaining` continua honesto. Só as duas rotas de busca contam contra ela. |
| RATE_LIMIT_EXCEEDED | 429 | A janela curta de pico da conta está cheia. `X-RateLimit-Remaining` marca zero. É um teto na escala de segundos que se libera sozinho; nenhuma das janelas de cota foi tocada. |
Especificação legível por máquina
O documento OpenAPI abaixo é gerado a partir do servidor em execução e é o mesmo que esta página representa.