API 개요
소개
dta-wide API는 모바일 애플리케이션이 백엔드 서비스와 효율적으로 통신할 수 있도록 설계된 RESTful API 서비스입니다. 이 문서는 모바일 개발자가 API를 효과적으로 사용하는 데 필요한 지침을 제공합니다.
API 사용 방법
모든 API 엔드포인트는 다음 베이스 URL을 사용합니다:
https://api-{dev|stage|prod}.sleepq.ai/de/v1
각 도메인에 맞는 엔드포인트를 호출하여 필요한 데이터를 요청하거나 작업을 수행할 수 있습니다.
API 도메인 구조
API는 다음과 같은 주요 도메인으로 구분됩니다:
| 도메인 | 설명 | 엔드포인트 기본 경로 |
|---|---|---|
| 사용자 (User) | 사용자 관리 및 프로필 | /de/v1/users |
| 인증 (Auth) | 인증 및 토큰 관리 | /de/v1/auth |
| IAM | 권한 및 접근 관리 | /de/v1/iam |
| 학습 (Learning) | 학습 콘텐츠 및 진행도 | /de/v1/learning |
| 시간 (TimeMachine) | 시스템 시간 관리 | /de/v1/time-machine |
| 접근 코드 (Access Code) | 접근 코드 관리 | /de/v1/access-codes |
주요 API 공통 기능
1. 인증
모든 보호된 API 엔드포인트는 JWT 기반 인증을 사용합니다. 인증 토큰은 /de/v1/auth/login 엔드포인트를 통해 획득할 수 있습니다.
2. 데이터 페이지네이션
대량의 데이터를 반환하는 API는 페이지네이션을 지원합니다. 페이지 번호와 페이지 크기를 지정하여 데이터를 나눠서 받을 수 있습니다.
3. 데이터 필터링 및 정렬
많은 API는 filter 및 sort 파라미터를 통해 데이터 필터링과 정렬을 지원합니다.
4. 에러 처리
API는 표준 HTTP 상태 코드와 자세한 에러 메시지를 통해 문제 상황을 명확하게 전달합니다.
도메인별 API 설명서
각 도메인별 자세한 API 정보는 API 레퍼런스 섹션에서 확인할 수 있습니다.