인증과 한도
API 키 발급 방법과 요청 한도를 안내합니다.
키가 필요 없는 엔드포인트도 있지만, 플레이어 정보처럼 사람과 관련된 자료는 키가 필요합니다.
키 발급#
API 키는 마코노미 디스코드에 계신 분께만 발급해 드려요.
디스코드에서 나가시면 운영진이 키를 폐기할 수 있어요.
developer.mcmi.kr 에서 디스코드로 로그인하시면 바로 발급받으실 수 있습니다.
마코노미 디스코드 멤버인지만 확인합니다. 다른 정보는 가져가지 않습니다.
무엇을 만드시는지 적어주시면 나중에 구분하기 좋습니다. 비워두셔도 됩니다.
발급 화면에서 딱 한 번만 보여드립니다. 새로고침하시면 다시 볼 수 없습니다.
포털에서 키의 마지막 사용 시각을 확인하시거나, 폐기하고 새로 발급받으실 수 있습니다.
| 항목 | 기본값 | 상향 |
|---|---|---|
| 계정당 활성 키 | 1개 | 신청해 주시면 검토합니다 |
| 요청 한도 | 분당 5회 | 포털에서 신청, 최대 분당 36,000회 |
| 키 없는 엔드포인트 | IP당 분당 30회 | 키를 보내셔도 IP당 분당 30회가 적용돼요 |
기본 한도가 낮은 것은 인색해서가 아니라, 어떻게 쓰이는지 보고 올려드리기 위해서입니다.
포털의 한도 상향 칸에 무엇을 만드시는지 적어주시면 대부분 그대로 올려드립니다.
결과는 디스코드로 알려드립니다.
키를 쓰는 법#
Authorization 헤더에 담아 보내주세요.
curl -H "Authorization: Bearer ml_여러분의키" \
https://api.mcmi.kr/v1/players/rihacats
const res = await fetch("https://api.mcmi.kr/v1/players/rihacats", {
headers: { Authorization: `Bearer ${process.env.MCMI_API_KEY}` },
});
const { data } = await res.json();
console.log(data.playtime.hours);
import os, requests
res = requests.get(
"https://api.mcmi.kr/v1/players/rihacats",
headers={"Authorization": f"Bearer {os.environ['MCMI_API_KEY']}"},
timeout=5,
)
print(res.json()["data"]["playtime"]["hours"])
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.mcmi.kr/v1/players/rihacats"))
.header("Authorization", "Bearer " + System.getenv("MCMI_API_KEY"))
.build();
X-API-Key: ml_여러분의키 도 똑같이 받습니다. 편한 쪽을 쓰세요.
키 관리#
키는 발급 순간에 딱 한 번만 보여드립니다. 저희도 다시 꺼내드릴 수 없습니다.
잃어버리시면 폐기하고 새로 발급받으셔야 합니다.
- 키는
ml_로 시작합니다. 이 접두사 덕분에 깃허브 등에 실수로 올라가면 탐지됩니다. - 공개 저장소나 프론트엔드 코드에 키를 넣지 말아주세요. 브라우저에서 직접 호출하는 구조는 키가 그대로 노출됩니다.
- 유출이 확인되면 사전 통보 없이 폐기합니다. 바로 말씀해 주시면 재발급해 드립니다.
- 키를 다른 분과 나눠 쓰시면 안 됩니다. 한도를 늘리려고 여러 계정으로 키를 받는 것도 마찬가지입니다.
한도 확인#
정상 처리된 요청과 429 응답에는 남은 횟수가 함께 와요. 키 오류(401)에는 오지 않아요.
RateLimit: limit=5, remaining=3, reset=42
RateLimit-Policy: 5;w=60
| 필드 | 뜻 |
|---|---|
limit | 이 키의 분당 한도 |
remaining | 이번 창에서 남은 횟수 |
reset | 몇 초 뒤에 창이 초기화되는지 |
한도를 넘기시면 429 와 함께 Retry-After 가 옵니다. 자세한 내용은 오류에 있습니다.
댓글
댓글은 마코노미 디스코드 서버 멤버만 쓸 수 있어요. 디스코드로 로그인