Tài liệu API
Một API khảo sát chỉ đọc. Mọi thứ bên dưới đều là GET, và một khoá đọc đúng những gì một người đã đăng nhập đọc được — không hơn.
Xác thực
Hãy gửi khoá của bạn trong một trong hai tiêu đề. Không có gì khác xác thực một yêu cầu, và khoá gửi tới một tuyến không có trong danh sách này sẽ bị từ chối thay vì được phục vụ.
X-Api-Key: wos_YOUR_KEY
Hoặc, dưới dạng token bearer
Authorization: Bearer wos_YOUR_KEY
Bắt đầu nhanh
Hãy thay khoá bằng khoá của bạn.
curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"
Điểm cuối
| Phương thức | Đường dẫn | Trả về gì | Được tính là |
|---|---|---|---|
| GET | /v1/alliances/{aid}/members | Lấy một Liên Minh cùng danh sách thành viên | Yêu cầu |
| GET | /v1/alliances/leaderboard | Xếp hạng Liên Minh theo tổng Sức Mạnh | Yêu cầu |
| GET | /v1/alliances/recruiting | Liệt kê các Liên Minh đang nhận đơn | Yêu cầu |
| GET | /v1/alliances/search | Tìm Liên Minh theo thẻ hoặc tên | Tìm kiếm |
| GET | /v1/players/{uid} | Lấy một Lãnh Chúa theo uid nội bộ | Yêu cầu |
| GET | /v1/players/search | Tìm Lãnh Chúa theo tên hoặc mã định danh | Tìm kiếm |
Gói và giới hạn
Giá trị vận hành hiện thời, không phải quyền lợi cố định. Chúng có thể thay đổi.
Mọi giới hạn đều tính theo tài khoản. Thêm khoá không mua thêm ngân sách.
Cả hai khung hạn mức đều TRƯỢT chứ không phải kỳ theo lịch: khung đọc nhìn lại ba mươi ngày tính từ hiện tại và khung tìm kiếm nhìn lại hai mươi tư giờ. Hạn mức và tìm kiếm được đo theo TÀI KHOẢN chứ không theo khoá — mọi khoá của một tài khoản đều rút từ cùng một ngân sách.
Tiêu đề phản hồi
Một phản hồi được phục vụ mang đủ tất cả, và một lần từ chối vì hạn mức cũng vậy. Lần từ chối vì đỉnh chỉ mang ba tiêu đề có tiền tố X-RateLimit, còn yêu cầu bị từ chối trước khi đo — 401 hoặc 403 — không mang tiêu đề nào.
| Tiêu đề | Ý nghĩa |
|---|---|
| X-Quota-Limit | Định mức đọc của tài khoản cho khung ba mươi ngày trượt. |
| X-Quota-Remaining | Số lượt đọc còn lại trong khung đó. |
| X-Quota-Reset | Giây Unix khi lượt đọc cũ nhất rơi khỏi khung. |
| X-Search-Limit | Định mức tìm kiếm của tài khoản cho khung hai mươi tư giờ trượt. |
| X-Search-Remaining | Số lượt tìm còn lại trong khung đó. |
| X-Search-Reset | Giây Unix khi lượt tìm cũ nhất rơi khỏi khung. |
| X-RateLimit-Limit | Định mức đỉnh của tài khoản cho khung ngắn. |
| X-RateLimit-Remaining | Số yêu cầu còn lại trong khung đỉnh. |
| X-RateLimit-Reset | Giây Unix khi khung đỉnh xoay vòng. |
| Retry-After | Số giây cần chờ trước khi thử lại. Được gửi kèm mọi mã 429, và riêng cho khung đã từ chối. |
Khi bị từ chối
Có ba thứ khác nhau trả lời bằng mã 429, và chúng không thay thế cho nhau được.
| Mã lỗi | Chuyện gì đã xảy ra |
|---|---|
| QUOTA_EXCEEDED | Hạn mức đọc ba mươi ngày trượt của tài khoản đã hết. `X-Quota-Remaining` báo không; `X-Search-Remaining` vẫn trung thực. |
| SEARCH_QUOTA_EXCEEDED | Hạn mức tìm kiếm hai mươi tư giờ trượt của tài khoản đã hết. `X-Search-Remaining` báo không; `X-Quota-Remaining` vẫn trung thực. Chỉ hai tuyến tìm kiếm mới bị tính vào đó. |
| RATE_LIMIT_EXCEEDED | Khung đỉnh ngắn của tài khoản đã đầy. `X-RateLimit-Remaining` báo không. Đây là trần ở thang giây và tự giải toả; không khung hạn mức nào bị đụng tới. |
Mã lỗi
| Mã | Trạng thái | Ý nghĩa |
|---|---|---|
| INVALID_API_KEY | 401 | Khoá không được nhận diện, đã bị thu hồi, hoặc tài khoản sở hữu nó đã bị xoá. |
| ENDPOINT_NOT_ALLOWED | 403 | Tuyến này không thuộc bề mặt dành cho nhà phát triển. Khoá xuất trình trên một tuyến ngoài bề mặt đó sẽ bị từ chối thay vì được phục vụ, nên đừng gửi khoá tới những điểm cuối mà tài liệu này không liệt kê. |
| QUOTA_EXCEEDED | 429 | Hạn mức đọc ba mươi ngày trượt của tài khoản đã hết. `X-Quota-Remaining` báo không; `X-Search-Remaining` vẫn trung thực. |
| SEARCH_QUOTA_EXCEEDED | 429 | Hạn mức tìm kiếm hai mươi tư giờ trượt của tài khoản đã hết. `X-Search-Remaining` báo không; `X-Quota-Remaining` vẫn trung thực. Chỉ hai tuyến tìm kiếm mới bị tính vào đó. |
| RATE_LIMIT_EXCEEDED | 429 | Khung đỉnh ngắn của tài khoản đã đầy. `X-RateLimit-Remaining` báo không. Đây là trần ở thang giây và tự giải toả; không khung hạn mức nào bị đụng tới. |
Đặc tả máy đọc được
Tài liệu OpenAPI bên dưới được sinh ra từ máy chủ đang chạy và chính là tài liệu mà trang này hiển thị.