WEBCEPH API

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

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

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

• 夥伴 API 金鑰 將發給已商定合併的夥伴。
  (按版本或時間段對 API 鍵進行修改以維護安全。 當需要為安全目的進行修改時,將提前通知合作伙伴 。 )
• 合作軟體整合功能僅向 WEBCEPH Premium 及更高等級的會員提供。
• We do not provide data via API such as landmark points, analysis results, or other clinical and diagnostic information.

請求限制

• 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",
        "thumbnail": "https://secure-images.webceph.com/media/sample-eo1.jpg",
        "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",
            "thumbnail": "Image URL",
        },
        ....
    ],
    "linkid": "Y7zv7pFl950eGk",
    "link": "https://webceph.com/records/Y7zv7pFl950eGk/"
}

獲取記錄細節

• 透過傳送患者身份、記錄日期來獲取記錄的細節

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

建立新患者

• 透過傳送患者 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",
    "big": "Image URL",
    "thumbnail": "Image URL",
    "linkid": "Adzv7pFl95234k",
    "link": "https://webceph.com/records/Adzv7pFl95234k/"
}