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 | 영주를 이름이나 영주 ID로 검색하기 | 검색 |
요금제와 한도
현재 운영 중인 값이며 보장된 권리가 아닙니다. 바뀔 수 있습니다.
모든 한도는 계정 단위입니다. 키를 더 만든다고 예산이 늘지 않습니다.
두 할당량 창 모두 달력 주기가 아니라 이동 창입니다. 읽기 창은 지금으로부터 삼십 일 전까지, 검색 창은 이십사 시간 전까지를 봅니다. 할당량과 검색은 키 단위가 아니라 계정 단위로 측정되며, 계정이 가진 모든 키가 하나의 예산에서 차감됩니다.
응답 헤더
정상 응답은 이 헤더를 모두 담으며, 할당량 초과 거부도 마찬가지입니다. 순간 한도 거부는 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`은 0을 가리키고 `X-Search-Remaining`은 그대로 정직합니다. |
| SEARCH_QUOTA_EXCEEDED | 계정의 이동 이십사 시간 검색 할당량을 다 썼습니다. `X-Search-Remaining`은 0을 가리키고 `X-Quota-Remaining`은 그대로 정직합니다. 여기에는 검색 경로 두 개만 집계됩니다. |
| RATE_LIMIT_EXCEEDED | 계정의 짧은 순간 한도 창이 가득 찼습니다. `X-RateLimit-Remaining`은 0을 가리킵니다. 초 단위 규모의 천장이며 저절로 풀리고, 두 할당량 창 어느 쪽도 건드리지 않았습니다. |
오류 코드
| 코드 | 상태 | 의미 |
|---|---|---|
| INVALID_API_KEY | 401 | 알 수 없는 키이거나, 폐기되었거나, 그 키를 가진 계정이 삭제되었습니다. |
| ENDPOINT_NOT_ALLOWED | 403 | 그 경로는 개발자 표면에 없습니다. 표면 밖의 경로에 키를 제시하면 응답 대신 거부되므로, 이 문서에 없는 엔드포인트로는 키를 보내지 마세요. |
| QUOTA_EXCEEDED | 429 | 계정의 이동 삼십 일 읽기 할당량을 다 썼습니다. `X-Quota-Remaining`은 0을 가리키고 `X-Search-Remaining`은 그대로 정직합니다. |
| SEARCH_QUOTA_EXCEEDED | 429 | 계정의 이동 이십사 시간 검색 할당량을 다 썼습니다. `X-Search-Remaining`은 0을 가리키고 `X-Quota-Remaining`은 그대로 정직합니다. 여기에는 검색 경로 두 개만 집계됩니다. |
| RATE_LIMIT_EXCEEDED | 429 | 계정의 짧은 순간 한도 창이 가득 찼습니다. `X-RateLimit-Remaining`은 0을 가리킵니다. 초 단위 규모의 천장이며 저절로 풀리고, 두 할당량 창 어느 쪽도 건드리지 않았습니다. |
기계가 읽는 규격
아래 OpenAPI 문서는 실행 중인 서버에서 생성되며, 이 페이지가 보여 주는 것과 동일합니다.