Rujukan API

API sensus yang hanya membaca. Semua di bawah ini adalah GET, dan sebuah kunci membaca persis apa yang dibaca orang yang sudah masuk — tidak lebih.

Autentikasi

Kirim kuncimu di salah satu dari dua header. Tidak ada hal lain yang mengautentikasi permintaan, dan kunci yang dikirim ke rute yang tidak tercantum di sini ditolak alih-alih dilayani.

X-Api-Key: wos_YOUR_KEY

Atau, sebagai token bearer

Authorization: Bearer wos_YOUR_KEY

Mulai cepat

Ganti kunci itu dengan milikmu.

curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"

Endpoint

Metode	Jalur	Apa yang dikembalikan	Dihitung sebagai
GET	/v1/alliances/{aid}/members	Ambil satu Aliansi beserta daftar anggotanya	Permintaan
GET	/v1/alliances/leaderboard	Urutkan Aliansi menurut total Kekuasaan	Permintaan
GET	/v1/alliances/recruiting	Daftar Aliansi yang menerima lamaran	Permintaan
GET	/v1/alliances/search	Cari Aliansi menurut tag atau nama	Pencarian
GET	/v1/players/{uid}	Ambil satu Gubernur lewat uid internal	Permintaan
GET	/v1/players/search	Cari Gubernur menurut nama atau pengenal Gubernur	Pencarian

Paket dan batas

Nilai operasional saat ini, bukan hak yang melekat. Nilai ini bisa berubah.

Setiap batas berlaku per akun. Kunci tambahan tidak membeli anggaran tambahan.

Kedua jendela kuota itu BERJALAN, bukan periode kalender: jendela baca menengok tiga puluh hari ke belakang dari sekarang dan jendela pencarian dua puluh empat jam. Kuota dan pencarian diukur per AKUN, bukan per kunci — setiap kunci yang dipegang sebuah akun menarik dari satu anggaran.

Header respons

Respons yang dilayani membawa semuanya, begitu pula penolakan karena kuota. Penolakan karena puncak hanya membawa tiga header berawalan X-RateLimit, dan permintaan yang ditolak sebelum dihitung — 401 atau 403 — tidak membawa satu pun.

Header	Arti
X-Quota-Limit	Jatah baca akun untuk jendela tiga puluh hari berjalan.
X-Quota-Remaining	Sisa bacaan di jendela itu.
X-Quota-Reset	Detik Unix saat bacaan terlama keluar dari jendela.
X-Search-Limit	Jatah pencarian akun untuk jendela dua puluh empat jam berjalan.
X-Search-Remaining	Sisa pencarian di jendela itu.
X-Search-Reset	Detik Unix saat pencarian terlama keluar dari jendela.
X-RateLimit-Limit	Jatah puncak akun untuk jendela singkat.
X-RateLimit-Remaining	Sisa permintaan di jendela puncak.
X-RateLimit-Reset	Detik Unix saat jendela puncak berputar.
Retry-After	Detik yang harus ditunggu sebelum mencoba lagi. Dikirim pada setiap 429, dan khusus untuk jendela yang menolak.

Saat ditolak

Ada tiga hal berbeda yang menjawab dengan 429, dan ketiganya tidak bisa saling menggantikan.

Kode galat	Apa yang terjadi
QUOTA_EXCEEDED	Kuota baca tiga puluh hari berjalan milik akun sudah habis. `X-Quota-Remaining` menunjukkan nol; `X-Search-Remaining` tetap jujur.
SEARCH_QUOTA_EXCEEDED	Kuota pencarian dua puluh empat jam berjalan milik akun sudah habis. `X-Search-Remaining` menunjukkan nol; `X-Quota-Remaining` tetap jujur. Hanya dua rute pencarian yang dihitung ke sana.
RATE_LIMIT_EXCEEDED	Jendela puncak singkat milik akun sedang penuh. `X-RateLimit-Remaining` menunjukkan nol. Ini batas pada skala detik yang lepas dengan sendirinya; tidak ada jendela kuota yang tersentuh.

Ambil keputusan mencoba ulang dari kode `error` dan header `Retry-After`, jangan pernah dari penghitung sisa. Penolakan bulanan dan penolakan pencarian harian sama-sama 429 dan keduanya membiarkan penghitung sisa jendela YANG LAIN jujur bukan nol, sehingga klien yang hanya memantau `X-Quota-Remaining` akan melihat 429 di samping sisa yang besar dan menyimpulkan servernya rusak.

Kode galat

Kode	Status	Arti
INVALID_API_KEY	401	Kunci tidak dikenal, sudah dicabut, atau akun pemiliknya telah dihapus.
ENDPOINT_NOT_ALLOWED	403	Rute ini bukan bagian dari permukaan pengembang. Kunci yang disodorkan pada rute di luar permukaan itu ditolak alih-alih dilayani, jadi jangan kirim kunci ke endpoint yang tidak dicantumkan dokumen ini.
QUOTA_EXCEEDED	429	Kuota baca tiga puluh hari berjalan milik akun sudah habis. `X-Quota-Remaining` menunjukkan nol; `X-Search-Remaining` tetap jujur.
SEARCH_QUOTA_EXCEEDED	429	Kuota pencarian dua puluh empat jam berjalan milik akun sudah habis. `X-Search-Remaining` menunjukkan nol; `X-Quota-Remaining` tetap jujur. Hanya dua rute pencarian yang dihitung ke sana.
RATE_LIMIT_EXCEEDED	429	Jendela puncak singkat milik akun sedang penuh. `X-RateLimit-Remaining` menunjukkan nol. Ini batas pada skala detik yang lepas dengan sendirinya; tidak ada jendela kuota yang tersentuh.

Spesifikasi terbaca mesin

Dokumen OpenAPI di bawah ini dihasilkan dari server yang sedang berjalan dan sama persis dengan yang ditampilkan halaman ini.

Unduh openapi.json

Ketentuan