คู่มืออ้างอิง API
API ข้อมูลสำรวจแบบอ่านอย่างเดียว ทุกอย่างด้านล่างเป็น GET และคีย์หนึ่งอ่านได้เท่ากับที่คนซึ่งเข้าสู่ระบบแล้วอ่านได้ ไม่มากไปกว่านั้น
การยืนยันตัวตน
ส่งคีย์ของคุณในส่วนหัวอันใดอันหนึ่งจากสองอัน ไม่มีสิ่งอื่นที่ยืนยันตัวตนของคำขอ และคีย์ที่ส่งไปยังเส้นทางซึ่งไม่ได้อยู่ในรายการนี้จะถูกปฏิเสธแทนที่จะได้รับการตอบสนอง
X-Api-Key: wos_YOUR_KEY
หรือในรูปโทเค็นแบบ bearer
Authorization: Bearer wos_YOUR_KEY
เริ่มต้นอย่างรวดเร็ว
แทนที่คีย์ด้วยคีย์ของคุณเอง
curl -H "X-Api-Key: wos_YOUR_KEY" \ "https://api.wosatlas.com/v1/players/search?playerName=LordFrost"
ปลายทาง
| เมธอด | เส้นทาง | คืนค่าอะไร | นับเป็น |
|---|---|---|---|
| GET | /v1/alliances/{aid}/members | ดึงข้อมูลพันธมิตรหนึ่งแห่งพร้อมรายชื่อสมาชิก | คำขอ |
| GET | /v1/alliances/leaderboard | จัดอันดับพันธมิตรตามค่าพลังรวม | คำขอ |
| GET | /v1/alliances/recruiting | แสดงรายชื่อพันธมิตรที่เปิดรับใบสมัคร | คำขอ |
| GET | /v1/alliances/search | ค้นหาพันธมิตรจากรหัสย่อหรือชื่อ | การค้นหา |
| GET | /v1/players/{uid} | ดึงข้อมูลผู้นำค่ายหนึ่งคนด้วย uid ภายใน | คำขอ |
| GET | /v1/players/search | ค้นหาผู้นำค่ายจากชื่อหรือรหัสประจำตัว | การค้นหา |
แพ็กเกจและขีดจำกัด
ค่าที่ใช้เดินระบบอยู่ตอนนี้ ไม่ใช่สิทธิ์ที่ผูกมัด ค่าเหล่านี้เปลี่ยนได้
ทุกขีดจำกัดนับต่อบัญชี คีย์เพิ่มไม่ได้ซื้องบเพิ่ม
ช่วงโควตาทั้งสองเป็นแบบเลื่อน ไม่ใช่รอบตามปฏิทิน ช่วงการอ่านย้อนหลังสามสิบวันนับจากตอนนี้ และช่วงการค้นหาย้อนหลังยี่สิบสี่ชั่วโมง โควตาและการค้นหาวัดต่อบัญชี ไม่ใช่ต่อคีย์ ทุกคีย์ที่บัญชีถืออยู่ดึงจากงบก้อนเดียวกัน
ส่วนหัวของการตอบกลับ
การตอบกลับที่ให้บริการแล้วมีครบทุกอัน และการปฏิเสธเพราะโควตาก็เช่นกัน การปฏิเสธเพราะอัตราพุ่งมีเพียงสามส่วนหัวที่ขึ้นต้นด้วย X-RateLimit ส่วนคำขอที่ถูกปฏิเสธก่อนการนับ — 401 หรือ 403 — ไม่มีสักอัน
| ส่วนหัว | ความหมาย |
|---|---|
| X-Quota-Limit | โควตาการอ่านของบัญชีสำหรับช่วงเลื่อนสามสิบวัน |
| X-Quota-Remaining | จำนวนการอ่านที่เหลือในช่วงนั้น |
| X-Quota-Reset | เวลาแบบวินาที Unix ที่การอ่านเก่าที่สุดหลุดออกจากช่วง |
| X-Search-Limit | โควตาการค้นหาของบัญชีสำหรับช่วงเลื่อนยี่สิบสี่ชั่วโมง |
| X-Search-Remaining | จำนวนการค้นหาที่เหลือในช่วงนั้น |
| X-Search-Reset | เวลาแบบวินาที Unix ที่การค้นหาเก่าที่สุดหลุดออกจากช่วง |
| X-RateLimit-Limit | โควตาอัตราพุ่งของบัญชีสำหรับช่วงสั้น |
| X-RateLimit-Remaining | จำนวนคำขอที่เหลือในช่วงอัตราพุ่ง |
| X-RateLimit-Reset | เวลาแบบวินาที Unix ที่ช่วงอัตราพุ่งหมุนรอบ |
| Retry-After | จำนวนวินาทีที่ต้องรอก่อนลองใหม่ ส่งมาพร้อมทุกรหัส 429 และเจาะจงกับช่วงที่ปฏิเสธ |
เมื่อถูกปฏิเสธ
มีสามเรื่องต่างกันที่ตอบกลับด้วย 429 และทั้งสามใช้แทนกันไม่ได้
| รหัสข้อผิดพลาด | เกิดอะไรขึ้น |
|---|---|
| QUOTA_EXCEEDED | โควตาการอ่านแบบเลื่อนสามสิบวันของบัญชีถูกใช้หมดแล้ว `X-Quota-Remaining` แสดงศูนย์ ส่วน `X-Search-Remaining` ยังคงตรงตามจริง |
| SEARCH_QUOTA_EXCEEDED | โควตาการค้นหาแบบเลื่อนยี่สิบสี่ชั่วโมงของบัญชีถูกใช้หมดแล้ว `X-Search-Remaining` แสดงศูนย์ ส่วน `X-Quota-Remaining` ยังคงตรงตามจริง มีเพียงสองเส้นทางค้นหาเท่านั้นที่นับเข้าโควตานี้ |
| RATE_LIMIT_EXCEEDED | ช่วงอัตราพุ่งสั้น ๆ ของบัญชีเต็มแล้ว `X-RateLimit-Remaining` แสดงศูนย์ นี่คือเพดานระดับวินาทีที่คลายตัวเอง และไม่ได้แตะโควตาช่วงใดเลย |
รหัสข้อผิดพลาด
| รหัส | สถานะ | ความหมาย |
|---|---|---|
| INVALID_API_KEY | 401 | ไม่รู้จักคีย์นี้ คีย์ถูกเพิกถอน หรือบัญชีที่เป็นเจ้าของถูกลบไปแล้ว |
| ENDPOINT_NOT_ALLOWED | 403 | เส้นทางนี้ไม่ได้อยู่บนพื้นที่สำหรับนักพัฒนา คีย์ที่ยื่นบนเส้นทางนอกพื้นที่นั้นจะถูกปฏิเสธแทนที่จะได้รับการตอบสนอง ดังนั้นอย่าส่งคีย์ไปยังปลายทางที่เอกสารนี้ไม่ได้ระบุไว้ |
| QUOTA_EXCEEDED | 429 | โควตาการอ่านแบบเลื่อนสามสิบวันของบัญชีถูกใช้หมดแล้ว `X-Quota-Remaining` แสดงศูนย์ ส่วน `X-Search-Remaining` ยังคงตรงตามจริง |
| SEARCH_QUOTA_EXCEEDED | 429 | โควตาการค้นหาแบบเลื่อนยี่สิบสี่ชั่วโมงของบัญชีถูกใช้หมดแล้ว `X-Search-Remaining` แสดงศูนย์ ส่วน `X-Quota-Remaining` ยังคงตรงตามจริง มีเพียงสองเส้นทางค้นหาเท่านั้นที่นับเข้าโควตานี้ |
| RATE_LIMIT_EXCEEDED | 429 | ช่วงอัตราพุ่งสั้น ๆ ของบัญชีเต็มแล้ว `X-RateLimit-Remaining` แสดงศูนย์ นี่คือเพดานระดับวินาทีที่คลายตัวเอง และไม่ได้แตะโควตาช่วงใดเลย |
ข้อกำหนดที่เครื่องอ่านได้
เอกสาร OpenAPI ด้านล่างถูกสร้างจากเซิร์ฟเวอร์ที่กำลังทำงานอยู่ และเป็นฉบับเดียวกับที่หน้านี้แสดง