내 진료 정보 열람
POST
https://api.candiy.io/v1/hira/medical_record
내 진료 정보를 조회합니다.
시간제한 (Timeout): 300초(sec)입력부(input)
| Key | Name | Type | Description |
|---|---|---|---|
| id *required | 요청 식별 아이디(SSO(동일계정) 구분값) | String | 사용자 계정을 식별할 수 있는 유일 값 세팅 (ex. 아이디 + UUID) |
| loginType | 인증 방식 구분 값 | String | (기본값: 5) 2: 휴대폰 인증, 5: 간편인증 |
| loginTypeLevel | 로그인 인증서 구분 값 | String | (기본값: 1) |
| legalName *required | 사용자 본명 | String | 사용자 본명 |
| identity *required | 사용자 주민등록번호 | String | 주민등록번호 13자리 |
| phoneNo *required | 사용자 명의 전화번호(핸드폰) | String | 숫자없이 번호만 입력 |
| telecom *required | 통신사 구분 값 | String | 0: SKT, 1: KT, 2: LG U+, |
| startDate | 조회 시작 연도 | String | yyyy-mm-dd 형식의 날짜 (기본값: 1년 전) |
| endDate | 조회 종료 연도 | String | yyyy-mm-dd 형식의 날짜 (기본값: 어제 날짜) |
Example
입력부 특이사항
- 최근 5년 정보를 제공합니다. 조회 시작/종료 일자 입력 시 기간내 정보만 제공합니다.
- id는 일정 시간(로그인 세션)동안 사용자 계정을 식별할 수 있는 유일 값을 지정해야 합니다. (예시: 아이디 + UUID)
- 휴대폰 문자 인증 사용을 원하시면, loginType을 2로 설정하고, telecom을 입력해야 사용 가능합니다.
추가인증 출력부(Output)
해당 상품은 추가인증이 필요합니다. 상태코드에 따라 추가인증 요청 상태를 확인할 수 있습니다.
| Key | Name | Type | Description |
|---|---|---|---|
| status | 상태코드 | String | 상태를 나타내는 상태코드 (success, error) |
|
data
|
응답 값 | Object | 실제 응답 데이터가 들어가는 응답값 |
Example
추가인증 입력부(Input)
| Key | Name | Type | Description |
|---|---|---|---|
| isContinue *required | 간편인증 | String | 0: cancel , 1: ok |
| smsAuthNo | 휴대폰 문자 인증번호 | String | 휴대폰 문자인증 시, 인증번호 |
|
multiFactorInfo
*required
|
추가 인증 정보 | Object | 1차 요청 응답 값 |
Example
추가인증 처리 방식
- [기본 요청]
- 요청 : 입력부(Input) : [기본 파라미터]
- 응답 : 추가인증 출력부(Output)
- [간편인증 추가인증]
- 요청 : [기본 파라미터] + [간편인증 요청 파라미터]
- 추가인증 입력부(Input) : isContinue 입력
- 응답 : 출력부(Output)
- [휴대폰 문자인증]
- 요청 : [기본 파라미터] + [휴대폰 문자 인증 요청 파라미터]
- 추가인증 입력부(Input) : smsAuthNo 입력
- 응답 : 출력부(Output)
추가인증 특이 사항
- 간편 인증 타임 아웃 4분 30초입니다.
- 간편 인증 시 인증을 완료하지 않은 경우 "Bad Request: 본인인증 절차가 완료되지 않았습니다. 먼저 본인인증을 완료해주세요." 오류가 발생합니다.
- 문자 인증이 필요한 경우에 smsAuthNo 파라미터를 입력해야 합니다.
- 문자 인증 타임 아웃은 3분입니다. 3분 이후에는 인증 타임 아웃이 발생합니다.
- 문자인증은 최대 3번까지 시도 가능합니다. 3회 이상 틀린 경우, 오류가 발생합니다.
- 문자 인증 시, 인증을 완료하지 않은 경우, "Bad Request: 인증번호가 일치하지 않습니다. 올바른 인증번호를 입력했는지 확인해주세요." 오류가 발생합니다. 이후 재시도가 가능합니다.
- 문자 인증이 3회 이상 틀린 경우, "Forbidden : SMS 인증은 최대 3회까지만 가능합니다. 다시 시도하려면 처음부터 시작해주세요." 이후 1차 요청부터 다시 진행해야 합니다.
출력부(Output)
| Key | Name | Type | Description |
|---|---|---|---|
| status | 상태코드 | String | 상태를 나타내는 상태코드 (success, error) |
|
data
|
응답 값 | Object | 실제 응답 데이터가 들어가는 응답값 |
