마인플랫폼 문서

테마

공개 API 개요 ​

마인플랫폼 공개 사용자 API는 대시보드에서 발급한 API 키로, 내 계정에 등록된 개인 서버 정보를 프로그램·봇·자동화 도구에서 조회할 수 있게 해 줍니다.

문서 위치

이 문서는 https://docs.mineplatform.kr/api 에서 볼 수 있어요.
키 발급은 대시보드 → API 에서 해요.

Base URL ​

환경URL
프로덕션 (권장)https://api.mineplatform.kr
Workers 기본 호스트https://mineplatform-api.official-120.workers.dev

프로덕션 커스텀 도메인(api.mineplatform.kr)을 사용하세요. Workers 기본 호스트는 예비·점검용으로 둘 수 있어요.

현재 제공 엔드포인트 ​

MethodPath인증설명
GET/health없음서비스 생존 확인
GET/없음/health와 동일한 헬스 응답
GET/v1/serversBearer API 키내가 개인으로 등록한 서버 목록

인증·제한·오류 형식은 아래 문서를 먼저 읽으면 좋아요.

빠른 시작 ​

  1. 마인플랫폼에 로그인해요.
  2. 대시보드 → API에서 키를 발급해요. (mp_live_… 형태)
  3. 발급 직후 한 번만 전체 키가 보이므로 안전한 곳에 저장해요.
  4. 초보자용 따라하기의 코드를 복사해 키만 바꿔 실행해요.

또는 터미널에서 바로:

bash
# 본인 키로 바꿔서 실행해요
curl -H "Authorization: Bearer mp_live_YOUR_KEY" \
  "https://api.mineplatform.kr/v1/servers"

성공 시 JSON에 servers 배열이 옵니다. 자세한 필드는 서버 목록을 참고하세요.

설계 원칙 ​

  • 읽기 전용: 지금은 조회(GET)만 제공합니다. 서버 등록·수정·삭제는 웹 UI를 이용하세요.
  • 계정 소유 범위: 키는 발급한 사용자에게만 묶여 있어요. 다른 사용자·조직 서버는 나오지 않아요.
  • 개인 서버만: organization_id가 있는 조직 서버는 포함되지 않아요.
  • 키당 초당 1회: 남용 방지를 위해 1 RPS를 적용해요.
  • CORS 허용: 브라우저에서도 Authorization 헤더로 호출할 수 있어요. (Origin *)

API 버전 ​

경로에 v1이 붙어 있어요. 호환성을 깨는 변경이 필요하면 v2 등 새 경로를 추가하고, 기존 v1은 일정 기간 유지하는 것을 원칙으로 해요.

변경 이력은 Changelog를 참고하세요.

관련 링크 ​

링크설명
대시보드 API 키키 발급·삭제
서버 등록 가이드웹에서 서버 등록
서비스 소개플랫폼·API 소개 페이지
고객센터문의