Untitled
📘 3개 API 명세서 (최종 완전판)
🩺 API 1. 케어챗 사용 여부 및 기능별 진입 가능 여부 검증
📌 개요
해당 요양기관(병원)의 케어챗 사용 여부 및 각 기능(예약, 결과, 문진)의 사용 가능 여부를 검증하는 API입니다.
🔗 요청 정보
Method: POST
URL:
https://lifecheck.saeromcare.kr/api/partner/kare-chat/auth-check
🔗 Request
instUcd
요양기관번호
string
병원의 요양기관번호 (8자리)
"12345678"
필수
📥 Request 예시
{
"instUcd": "12345678"
}🔁 Response
iskarechatUsed
케어챗 진행기관여부
Boolean
케어챗 서비스 제공여부
true : 사용 / false : 미사용
필수
isReserveUsed
예약옵션 사용여부
Boolean
예약서비스 제공가능여부
true : 사용 / false : 미사용
필수
isResultUsed
결과옵션 사용여부
Boolean
결과서비스 제공가능여부
true : 사용 / false : 미사용
필수
isQuestionnaireUsed
(라이프터치) 문진사용여부
Boolean
문진서비스제공가능여부
true : 사용 / false : 미사용
필수
instCd
검진기관코드
string
검진기관 고유코드
ccomCd
고객사코드
string
개인검진 고유코드
📤 Response 예시
{
"iskarechatUsed": true,
"isReserveUsed" : true,
"isResultUsed": false,
"isQuestionnaireUsed": true
"instCd": "LC001",
"ccomCd": "COM001"
}⚠️ 오류 응답
400
ERR_001
MISSING_PARAMETER
instUcd 누락 등
404
ERR_002
INST_NOT_FOUND
등록되지 않은 instUcd
500
ERR_999
INTERNAL_ERROR
서버 내부 오류
❌ 오류 응답 예시
{
"code": "ERR_001",
"message": "MISSING_PARAMETER",
"status": 400
}📅 API 2. 예약정보 조회 API
📌 개요
사용자 또는 검진기관의 예약 정보를 조회하는 API입니다.
🔗 요청 정보
Method: POST
URL:
https://lifecheck.saeromcare.kr/api/partner/kare-chat/reserve-info
🔗 Request
instUcd
요양기관번호
string
병원의 요양기관번호 (8자리)
"12345678"
필수
ci
CI값
String
필수
name
성명
String
김치원
필수
birth
생년월일
String
1996-01-01
필수
phone
휴대폰번호
String
010-9999-9999
필수
foreign
내/외국인여부
String
내국인=1 / 외국인=2
선택
이메일
String
카카오계정
필수
entrTypeCd
개인검진여부
string
B2CC=개인 / B2CB=기업
필수
selfYn
본인검진여부
string
Y/N
필수
channelType
유입경로
string
karechet
필수
mdexRsvtid
예약ID
string
필수
case
버튼CASE
string
검진예약=1, 예약확인/변경,취소/자세히보기=2, 사전문진작성=3, 결과확인=4
필수
📥 Request 예시
{
"instUcd": "12345678",
"ci": "ABCD1234CI",
"name": "김치원",
"birth": "1996-01-01",
"phone": "010-9999-9999",
"email": "test@kakao.com",
"entrTypeCd": "B2CC",
"selfYn": "Y",
"channelType": "karechat",
"mdexRsvtid": "RSV001",
"case": "2"
}🔁 Response
mdexRsvtid
예약ID
string
필수
Firstdate
1차희망일
string
2025-09-09 오전
Seconddate
2차희망일
string
2025-09-10 오전
confirmdate
예약확정/검진완료일
string
2025-09-11 오전
prgmNm
프로그램명+유형명
string
[종합검진] MRI형
selfYn
본인검진여부
string
본인=1 / 대리예약=2
entrTypeCd
개인검진여부
string
B2CC=1 / B2CB=2
CcomNm
고객사명
string
삼성바이오로직스 / 개인검진
mdexStatCd
검진상태
string
예약상태 코드
예약신청=1, 변경예약신청=2, 예약확정=3
📤 Response 예시
{
"mdexRsvtid": "RSV001",
"Firstdate": "2025-09-09 오전",
"Seconddate": "2025-09-10 오전",
"confirmdate": "2025-09-11 오전",
"prgmNm": "[종합검진] MRI형",
"selfYn": "본인=1",
"entrTypeCd": "B2CC",
"CcomNm": "삼성바이오로직스",
"mdexStatCd": "1"
}⚠️ 오류 응답
400
ERR_001
MISSING_PARAMETER
instUcd 누락 등
404
ERR_002
INST_NOT_FOUND
등록되지 않은 instUcd
500
ERR_999
INTERNAL_ERROR
서버 내부 오류
❌ 오류 응답 예시
{
"code": "INST_NOT_FOUND",
"message": "해당 요양기관 정보를 찾을 수 없습니다.",
"status": 404
}🧾 API 3. 검진예약, 사전문진작성, 결과확인 필요 파라미터 리턴 API
📌 개요
문진 또는 검진 관련 정보를 요청하거나 처리하는 API입니다.
🔗 요청 정보
Method: POST
URL:
https://lifecheck.saeromcare.kr/api/partner/kare-chat/prepare
🔗 Request
instUcd
요양기관번호
string
병원의 요양기관번호 (8자리)
"12345678"
필수
ci
CI값
String
필수
name
성명
String
김치원
필수
birth
생년월일
String
1996-01-01
필수
phone
휴대폰번호
String
010-9999-9999
필수
foreign
내/외국인여부
String
내국인=1 / 외국인=2
선택
이메일
String
카카오계정
필수
entrTypeCd
개인검진여부
string
B2CC(개인)=1 / B2CB(기업)=2
필수
selfYn
본인검진여부
string
본인=1 / 대리예약=2
필수
channelType
유입경로
string
karechet
필수
mdexRsvtid
예약ID
string
필수
case
버튼CASE
string
① 검진예약=1, ② 예약확인/변경/취소/자세히보기=2, ③ 사전문진작성=3, ④ 결과확인=4
필수
📥 Request 예시
{
"instUcd": "12345678",
"ci": "EFGH5678CI",
"name": "김치원",
"birth": "1996-01-01",
"phone": "010-9999-9999",
"entrTypeCd": "B2CC",
"selfYn": "Y",
"case": "3"
}🔁 Response
instUcd
요양기관번호
string
병원의 요양기관번호 (8자리)
"12345678"
필수
ci
CI값
String
필수
name
성명
String
김치원
필수
birth
생년월일
String
1996-01-01
필수
phone
휴대폰번호
String
010-9999-9999
필수
foreign
내/외국인여부
String
내국인=1 / 외국인=2
선택
이메일
String
카카오계정
필수
entrTypeCd
개인검진여부
string
B2CC(개인)=1 / B2CB(기업)=2
필수
selfYn
본인검진여부
string
본인=1 / 대리예약=2
필수
channelType
유입경로
string
karechet
필수
mdexRsvtid
예약ID
string
필수
case
버튼CASE
string
① 검진예약=1, ② 예약확인/변경/취소/자세히보기=2, ③ 사전문진작성=3, ④ 결과확인=4
필수
📤 Response 예시
{
"instUcd": "12345678",
"ci": "EFGH5678CI",
"name": "김치원",
"birth": "1996-01-01",
"phone": "010-9999-9999",
"entrTypeCd": "B2CC",
"selfYn": "Y",
"case": "3"
}⚠️ 오류 응답
400
ERR_001
MISSING_PARAMETER
instUcd 누락 등
404
ERR_002
INST_NOT_FOUND
등록되지 않은 instUcd
500
ERR_999
INTERNAL_ERROR
서버 내부 오류
❌ 오류 응답 예시
{
"code": "INTERNAL_ERROR",
"message": "서버 내부 오류",
"status": 500
}Last updated