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提供标志点、分析结果或其他临床和诊断信息。

请求限制

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