Version: 1.0.1
KOS OpenAPI
KOS OpenAPI는 KOS 솔루션을 사용하는 병원들의 개발팀만 사용 가능합니다.
자세한 사항은 해당 병원의 KOS 영업 담당자를 통해 문의 바랍니다.
이 문서는 OpenAPI Spec 파일을 통해 확인할 수 있습니다.
API 요청 방법
-
KOS OpenAPI는 조회, 수정, 삭제 등 모두 POST 방식으로 요청합니다.
-
인증 관련을 제외한 모든 요청은
Authorization헤더에 인증 토큰(Auth Token)이 포함되어야 합니다. 자세한 내용은 인증 방법을 참고하세요. -
모든 에러 응답은 종류와 무관하게
400상태 코드를 반환합니다. 에러 응답의 상세 내용을 통해 에러 원인을 확인할 수 있습니다. 자세한 내용은 에러 응답을 참고하세요.
날짜 및 시간 형식
조회와 명령에 사용되는 모든 날짜 및 시간 형식은 ISO 8601 포맷의 문자열을 사용합니다.
YYYY-MM-DDTHH:MM:SSZ
예시: 2021-01-01T00:00:00Z
모든 날짜 및 시간은 UTC 시간대여야 합니다.
국가 코드 형식
모든 국가 코드는 ISO 3166-1 alpha-2 포맷의 문자열을 사용합니다.
예시: KR, US, JP, CN...
경고
단, 국가별로 보여줄 상품을 지정할 수 있고, 해당 국가에 맞는 수가를 설정하기 위한, '타겟 국가'의 '그 외 국가'는 ETC 로 표기합니다.
자세한 설명은 타겟 국가를 참고하세요.
에러 응답
조회 혹은 명령을 정상적으로 처리할 수 없는 경우, 400 HTTP 상태 코드와 함께 아래와 같은 에러 응답이 돌아옵니다.
{
"status": 400,
"message": "InvalidCommandException",
"className": "InvalidCommandException",
"errorProperties": [
{
"key": "{{ Key }}",
"reason": "{{ ErrorReason }}"
}
]
}
key: 누락된 필드명 혹은 잘못된 값을 가진 필드명reason: 에러 원인TooShort: 문자열이 너무 짧음TooLong: 문자열이 너무 길음Required: 필수 항목이 누락됨Duplicated: 중복됨InvalidTimeRange: 시간 범위 유효성 검사 실패NotAvailable: 사용 불가NotFound: 대상이 없음TooSmall: 너무 작은 값TooBig: 너무 큰 값