> ## Documentation Index
> Fetch the complete documentation index at: https://docs.studynest.kr/llms.txt
> Use this file to discover all available pages before exploring further.

# API 개요

> StudyNest API의 기본 경로, 인증 방식, 문서 범위를 설명합니다.

## 개요

StudyNest API의 기본 경로, 인증 방식, 문서 범위를 설명합니다. 이 문서는 StudyNest의 현재 메뉴 구조를 기준으로 작성되었습니다.

## 대상 사용자

* Platform 관리자
* Tenant 관리자
* Service 사용자
* API 개발자

## 필요한 권한

* 작업에 맞는 역할과 권한

## 접근 경로

* `/api/v1`

## 작업 전 확인사항

* Active Tenant가 올바른지 확인합니다.
* 작업 대상 사용자의 권한과 역할을 확인합니다.
* 변경 영향 범위를 확인합니다.

## 작업 절차

1. Base URL은 `/api/v1`입니다.
2. JWT Bearer Token을 준비합니다.
3. 요청 헤더에 `Authorization: Bearer <token>`을 포함합니다.
4. 응답 코드와 오류 메시지를 확인합니다.

## 요청 예시

```bash theme={null}
curl -X GET "https://portal.example.com/api/v1/auth/me" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example"
```

## 오류 예시

| 상태 코드 | 의미             | 조치                        |
| ----- | -------------- | ------------------------- |
| `401` | 인증 정보 없음 또는 만료 | 다시 로그인하거나 토큰을 갱신합니다.      |
| `403` | 권한 부족          | 역할과 Active Tenant를 확인합니다. |
| `422` | 요청 값 검증 실패     | 필수 필드와 형식을 수정합니다.         |

## 작업 결과 확인

* 변경 후 대상 목록이나 상세 화면을 새로 고칩니다.
* 감사 로그 또는 최근 활동에 작업 이력이 남았는지 확인합니다.
* 관련 사용자가 의도한 메뉴와 데이터에 접근할 수 있는지 확인합니다.

## 관련 문서

* `ko/concepts/permissions` - 권한 모델 요약