API 개요

Multi-SaaS Kit REST API 레퍼런스입니다.

기본 정보

항목	값
Base URL	https://api.your-domain.com/api/v1
인증	Bearer Token (Sanctum)
응답 형식	JSON

인증

토큰 발급

POST /api/v1/auth/login
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "password"
}

응답:

{
  "access_token": "1|abc123...",
  "token_type": "Bearer",
  "expires_at": "2025-01-21T00:00:00Z"
}

토큰 사용

GET /api/v1/users/me
Authorization: Bearer 1|abc123...

공통 응답 형식

성공

{
  "success": true,
  "data": { ... },
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}

에러

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "email": ["The email field is required."]
  }
}

HTTP 상태 코드

코드	의미
200	성공
201	생성됨
400	잘못된 요청
401	인증 필요
403	권한 없음
404	리소스 없음
422	유효성 검사 실패
500	서버 오류

페이지네이션

GET /api/v1/users?page=2&per_page=20

응답의 meta:

{
  "current_page": 2,
  "per_page": 20,
  "total": 150,
  "last_page": 8
}

Rate Limiting

범위	제한
인증 요청	60회/분
일반 API	120회/분
관리자	300회/분

헤더:

X-RateLimit-Limit: 120
X-RateLimit-Remaining: 115

API 버전

URL 경로에 버전 포함:

/api/v1/users     # 버전 1
/api/v2/users     # 버전 2 (향후)

다음 단계

개별 API 문서는 추후 추가 예정입니다.