Successfully done.

STUDY GROUP

WEBCEPH API

WEBCEPH API

WEBCEPH API

API使用條款

使用審核：使用API須事先獲得WEBCEPH核准。僅憑訂閱等級並不取得API使用權限。
用途限制：API僅可由獲准機構在獲准系統中用於獲准目的。變更須事先獲得核准。
用量管理：WEBCEPH可限制請求頻率、病患登錄量及圖片上傳量。適用限額將於核准時或變更前告知。
第三方限制：禁止與第三方共用API金鑰、轉售或向他人再提供API存取權限。
安全與隱私：機構須擁有合法的資料處理權限，遵守適用的隱私保護要求，並保護API金鑰及其他驗證資訊。
支援範圍：支援可能僅限於官方文件。可能不提供個別開發、偵錯及客製化整合支援。
撤銷核准與暫停使用：WEBCEPH可基於安全違規、超出核准用途或系統負載過高等客觀原因撤銷核准或暫停存取。

* 注意事項：上述內容、API 驗證方式及 API 相關功能目前以測試版服務提供，可能在未事先通知的情況下變更。

本文件介紹 WEBCEPH 與第三方合作軟體（以下簡稱合作軟體）之間通訊及整合的 API。整合使用示例如下：

患者管理軟體：
點選患者管理軟體中的 WEBCEPH 快捷入口，即可在 WEBCEPH 中檢視和分析患者資料。
牙科成像軟體:
點選建立和分析患者 WEBCEPH 直接上傳到牙科成像軟體上

將軟體連線起來的條件和程式如下:

夥伴 API 金鑰 將發給已商定合併的夥伴。
(按版本或時間段對 API 鍵進行修改以維護安全。當需要為安全目的進行修改時,將提前通知合作伙伴。 )
合作軟體整合功能僅向 WEBCEPH Premium 及更高等級的會員提供。使用審核：使用API須事先獲得WEBCEPH核准。僅憑訂閱等級並不取得API使用權限。
我們不透過API提供標誌點、分析結果或其他臨床與診斷資訊。
基於病患醫療資訊保護及安全考量，不透過API提供影像匯出（包括原始影像、縮小影像及縮圖）。
使用限制：Partner API不得用於批次查詢WEBCEPH病患資訊及病患清單，亦不得用於查詢或下載已上傳至WEBCEPH的紀錄與照片。
Beta服務：WEBCEPH Partner API目前以免費Beta服務提供，未來預計轉為依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/";
}

獲取患者名單

按更新日期的順序檢索最新的10個專案
按名稱搜尋
由患者身份搜尋
以姓名或病人身份搜尋

[
    {
        "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/";
    }
]

獲取記錄列表

透過傳送患者身份資訊,獲取患者記錄列表

{
    "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/"
}

建立新患者

透過傳送患者 ID、姓氏、名字、種族、性別和出生日期來新增患者資訊

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

新增新記錄

透過傳送患者身份、記錄日期新增新記錄

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

上傳影像

將單個影像檔案上傳到特定患者的具體記錄
透過傳送患者身份、記錄日期、照片型別和照片資料上傳。

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