WEBCEPH API

웹셉 API

WEBCEPH API

API 이용약관

이용 승인: API 이용에는 WEBCEPH의 사전 승인이 필요합니다. 구독 등급만으로 API 이용 권한이 발생하지 않습니다.
이용 목적 제한: API는 승인받은 기관이 승인된 시스템과 목적에 한하여 이용할 수 있습니다. 변경 시 사전 승인을 받아야 합니다.
사용량 관리: WEBCEPH는 호출 빈도, 환자 등록량 및 이미지 업로드량을 제한할 수 있습니다. 적용 한도는 승인 시 또는 변경 전에 안내합니다.
제3자 제공 제한: 제3자와 API Key를 공유하거나 API 이용 권한을 재판매 또는 재제공하는 행위는 금지됩니다.
보안 및 개인정보 보호: 기관은 데이터에 대한 적법한 처리 권한을 확보하고, 적용되는 개인정보 보호 요건을 준수하며, API Key 등 인증정보를 보호해야 합니다.
지원 범위: 지원은 공식 문서로 제한될 수 있으며, 개별 개발, 디버깅 및 맞춤형 연동 지원은 제공하지 않을 수 있습니다.
승인 철회 및 이용 정지: WEBCEPH는 보안 위반, 승인 목적 외 사용, 과도한 시스템 부하 등 객관적인 사유가 있는 경우 승인을 철회하거나 이용을 정지할 수 있습니다.

* 유의사항: 위의 내용, API 인증 방법 및 API 관련 기능은 현재 베타 서비스로 사전 공지 없이 변경될 수 있습니다.

본 문서는 WEBCEPH과 파트너사 소프트웨어 간의 통신 및 연동을 위한 API 사용설명서입니다. 파트너사와의 통신 및 연동 사용 예시는 다음과 같습니다.

환자관리 소프트웨어:
환자관리 프로그램 상에서 WEBCEPH 바로가기를 클릭하여 해당 환자의 교정데이터 조회 및 분석
치과 이미징 소프트웨어:
치과 방사선사진 뷰어 프로그램 상에서 WEBCEPH으로 직접 이미지 업로드, 환자 생성 및 분석

소프트웨어간 연동을 위한 조건과 절차는 아래와 같습니다.

파트너사와의 협의 후 연동이 협의된 파트너사에게 Partner측 API Key를 발급해드립니다.
(버전 혹은 기간 별로 API Key를 변경하여 보안 유지를 하게 됩니다.)
WEBCEPH Premium 등급 이상의 회원인 경우, 파트너사의 소프트웨어와 연동이 가능합니다. 이용 승인: API 이용에는 WEBCEPH의 사전 승인이 필요합니다. 구독 등급만으로 API 이용 권한이 발생하지 않습니다.
계측점, 분석 결과 및 기타 임상·진단 정보는 API를 통해 제공하지 않습니다.
환자 의료정보 보호 및 보안상의 이유로 API를 통한 이미지 내보내기(원본, 축소 이미지 및 썸네일 포함)는 제공하지 않습니다.
이용 제한: Partner API는 WEBCEPH 환자 정보 및 목록의 일괄 조회, 이미 WEBCEPH에 업로드된 레코드 및 사진을 조회하거나 다운로드 받는 용도로는 사용할 수 없습니다.
베타 서비스: WEBCEPH Partner API는 현재 무료 베타 서비스로 제공되며, 향후 API 사용량 기반 유료 서비스로 전환될 예정입니다.

요청 제한

WEBCEPH 회원: 30회 요청 / 분

API 서비스

API 상태

{
    "status": "live",
    "version": "1.21",
    "timestamp": "2026-06-09 10:58:16.309983"
}

사용자 정보

{
    "email": "tester@tester.com",
    "firstname": "Fname",
    "lastname": "Lname",
    "membership": "free", // 소문자
    "region": "ap-northeast-2",
    "storage": "webceph-ko",
    "link": "https://webceph.com/records/";
}

환자 목록 받기

Updated 날짜 순으로 최신 10항목 받아옴.
이름으로 검색
Patient ID로 검색
이름 또는 Patient ID 모두로 검색

[
    {
        "patientid": "webceph-sample-001",
        "firstname": "Albert",
        "lastname": "Kim",
        "gender": "male", // 소문자
        "birthdate": "2000-01-01",
        "generatedtime": "2024-01-10T12:24:38.560183Z",
        "lastupdate": "2024-01-11T18:31:34.956682Z",
        "linkid": "Y7zv7pFl950eGk",
        "link": "https://webceph.com/records/Y7zv7pFl950eGk/";
    }
]

환자의 레코드 목록 받기

Patient ID 정보를 통해서 해당 환자의 레코드 목록을 얻기.

{
    "firstname": "Albert",
    "lastname": "Kim",
    "birthdate": "2000-01-01",
    "records": [
        {
            "recorddate": "2024-01-10", // 최신 레코드가 위로
            "recordhash": "2024-01-10"
        },
        ....
    ],
    "linkid": "Y7zv7pFl950eGk",
    "link": "https://webceph.com/records/Y7zv7pFl950eGk/"
}

신규 환자 생성

Patient ID, 성, 이름, 인종, 성별, 생일을 전송하여 새로운 환자 정보 추가.

{
    "result": "success",
    "patientid": "BBG7XKBTH",
    "linkid": "Adzv7pFl95234k",
    "link": "https://webceph.com/records/Adzv7pFl95234k/"
}

신규 레코드 생성

Patient ID, 레코드 날짜를 전송하여 새 레코드 추가.

{
    "result": "success",
    "patientid": "BBG7XKBTH",
    "recordhash": "2024-01-20",
    "linkid": "Adzv7pFl95234k",
    "link": "https://webceph.com/records/Adzv7pFl95234k/"
}

사진 파일 업로드

POST를 통해 단일 파일을 특정 환자의 특정 레코드의 특정 종류에 업로드
Patient ID, 레코드 날짜, 사진 종류 및 사진 데이터를 전송하여 업로드.

{
    "result": "success",
    "patientid": "BBG7XKBTH",
    "recordhash": "2024-01-12",
    "targetclass": "io_photo_frontal",
    "linkid": "Adzv7pFl95234k",
    "link": "https://webceph.com/records/Adzv7pFl95234k/"
}