WEBCEPH API

웹셉 API

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

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

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

파트너사와의 협의 후 연동이 협의된 파트너사에게 Partner측 API Key를 발급해드립니다.
(버전 혹은 기간 별로 API Key를 변경하여 보안 유지를 하게 됩니다.)
WEBCEPH Premium 등급 이상의 회원인 경우, 파트너사의 소프트웨어와 연동이 가능합니다.

요청 제한

WEBCEPH 회원: 30회 요청 / 분

API 서비스

API 상태

{
    "status": "live",
    "version": "1.1",
    "timestamp": "2024-01-24 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",
        "thumbnail": "https://webceph.s3.amazonaws.com:443/media/sample-eo1.jpg",
        "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",
            "thumbnail": "Image URL",
        },
        ....
    ],
    "linkid": "Y7zv7pFl950eGk",
    "link": "https://webceph.com/records/Y7zv7pFl950eGk/"
}

환자의 특정 레코드 정보 받기

Patient ID, 레코드 날짜를 전송하여 해당 레코드의 상세 정보를 얻기.

{
    "firstname": "Albert",
    "lastname": "Kim",
    "birthdate": "2000-01-01",
    "record": {
        "recorddate": "2024-01-09",
        "url_ceph": "Image URL",
        "url_ceph_big": "Image URL",
        "url_pa": "Image URL",
        "url_pa_big": "Image URL",
        ....
    },
    "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",
    "big": "Image URL",
    "thumbnail": "Image URL",
    "linkid": "Adzv7pFl95234k",
    "link": "https://webceph.com/records/Adzv7pFl95234k/"
}