인증 API 개요
참고: 이 문서에 설명된 모든 API는
dta-wir-medi-api애플리케이션에 구현되어 있습니다. (Go)
논의 사항
1. Domain 구조 정리
현재 상황:
- 현재 API 문서는
auth도메인으로 분리되어 있습니다. dta-wi-medi-api에서는 계정 비밀번호 관련 API가account도메인에 포함되어 있습니다.
결정 필요 사항:
-
도메인 분류 방식
- 현재의
auth도메인 분류를 유지할 것인가? - API 경로(path) 기준으로 도메인을 재구성할 것인가?
- 현재의
-
비밀번호 관련 API의 도메인 소속
dta-wi-medi-api의 방식을 따라account도메인으로 통일할 것인가?- 현재의
auth도메인 분류를 유지할 것인가?
2. Error Response 형식 통일
dta-wir-medi-api (Go)와 dta-wide-api (TypeScript)의 에러 응답 형식이 다릅니다.
Go 버전 (dta-wir-medi-api) - 현재 구조
{
"status": 400,
"code": 40000,
"message": "유효하지 않은 전화번호 형식입니다."
}
TypeScript 버전 (dta-wi-medi-api)
{
"status": 401,
"code": 1080,
"message": "UNAUTHORIZED",
"detail": "{\"displayText\":\"No token found in Authorization header\"}"
}
- 두 API 서버의 에러 응답 형식을 통일할 것인가? 통일한다면 기존 클라이언트도 수정할 것인가?
문서 업데이트:
- 위 논의 결과에 따라 각 API 문서의 에러 응답 섹션을 업데이트해야 합니다.
Account Password
dta-wir-medi-api, dta-wi-medi-api에서 중복되는 API가 있음.
개요
인증 API는 사용자 인증, 계정 관리, 토큰 관리, 사이트 등록 등을 담당하는 API 집합입니다.
인증 API 목록
계정 초대 관리 API
| API 엔드포인트 | 메서드 | 설명 | 문서 |
|---|---|---|---|
/v1/accounts/sites/{siteId}/invite | POST | 사이트에 계정 초대 | 상세보기 |
/v1/accounts/sites/{siteId}/invite | GET | 사이트 초대 목록 조회 | 상세보기 |
/v1/accounts/sites/{siteId}/invites/resend | POST | 초대 재발송 | 상세보기 |
/v1/invitations/{invitationUUID} | GET | 초대 정보 조회 | 상세보기 |
/v1/accounts/invitations/{invitationUUID} | POST | 초대를 통한 계정 생성 | 상세보기 |
계정 관리 API
| API 엔드포인트 | 메서드 | 설명 | 문서 |
|---|---|---|---|
/v1/accounts | POST | 계정 생성 | 상세보기 |
/v1/accounts/sites/{siteId} | GET | 사이트별 계정 목록 조회 | 상세보기 |
/v1/accounts/authorized/sites/{siteId} | GET | 처방 권한 계정 목록 조회 | 상세보기 |
/v1/accounts/{accountId}/profile | PATCH | 계정 프로필 수정 | 상세보기 |
/v1/accounts/{accountId}/position | PATCH | 계정 직위 수정 | 상세보기 |
/v1/accounts/delete | POST | 계정 삭제 | 상세보기 |
/v1/accounts/find-emails | POST | 이메일 찾기 | 상세보기 |
인증 및 세션 관리 API
| API 엔드포인트 | 메서드 | 설명 | 문서 |
|---|---|---|---|
/v1/accounts/login | POST | 로그인 | 상세보기 |
/v1/accounts/tokens/refresh | POST | 토큰 갱신 | 상세보기 |
/v1/my/profile | GET | 내 프로필 조회 | 상세보기 |
비밀번호 관리 API
| API 엔드포인트 | 메서드 | 설명 | 문서 |
|---|---|---|---|
/v1/accounts/password/reset/security-code/send | POST | 비밀번호 재설정 보안 코드 발송 | 상세보기 |
/v1/accounts/password/reset/security-code/verify | POST | 보안 코드 검증 | 상세보기 |
/v1/accounts/password/reset/security-code | POST | 보안 코드를 통한 비밀번호 재설정 | 상세보기 |
인증 요구 사항
대부분의 인증 API는 유효한 JWT 액세스 토큰이 필요합니다.
request header
Authorization: Bearer {access_token}
예외:
- 로그인 API (
/v1/accounts/login) - 초대를 통한 계정 생성 API (
/v1/accounts/invitations/{invitationUUID}) - 사이트 등록 요청 API (
/v1/sites/request-registration) - 비밀번호 관련 API 중 일부 (보안 코드 발송, 검증 등)는 이메일/비밀번호 또는 보안 코드로 인증합니다.