WEBCEPH API

API Terms of Use

Approval: API access requires prior approval from WEBCEPH. A subscription plan alone does not grant API access.
Permitted use: The API may be used only by the approved institution, in the approved systems and for the approved purposes. Changes require prior approval.
Usage limits: WEBCEPH may limit request frequency, patient registrations and image uploads. Applicable limits are communicated upon approval or in advance of changes.
Third parties: Sharing API keys with third parties, reselling API access or providing it to others is prohibited.
Security and privacy: The institution must have lawful authority to process the data, comply with applicable privacy requirements and protect API keys and other credentials.
Support: Support may be limited to official documentation. Individual development, debugging and custom integration support may not be provided.
Revocation and suspension: WEBCEPH may revoke approval or suspend access for objective reasons, including security violations, use outside the approved purposes or excessive system load.

* Please note: The above information, API authentication methods and API-related features are currently in beta and may change without prior notice.

This document is an API manual for communication and integration between WEBCEPH and third-party partner software (hereinafter referred to as Partner Software). Examples of communication and linkage use with partners are as follows:

Patient Management Software:
Click the WEBCEPH shortcut on the patient management software to view and analyze the patient's analysis data on WEBCEPH.
Dental Imaging Software:
Create and analyze patients by clicking WEBCEPH direct upload upload on the dental imaging software.

The conditions and procedures for linking between software are as follows:

Partner API Key will be issued to partners with whom integration has been agreed.
(API Key will be changed by version or period to maintain security. When changes are necessary for security purposes, partners will be notified in advance.)
The integration function with Partner Software is provided to members of WEBCEPH Premium level or higher. Approval: API access requires prior approval from WEBCEPH. A subscription plan alone does not grant API access.
We do not provide data via API such as landmark points, analysis results, or other clinical and diagnostic information.
For patient data protection and security reasons, image export (including original images, resized images and thumbnails) is not provided through the API.
Usage restrictions: The Partner API cannot be used for bulk retrieval of WEBCEPH patient information or patient lists, or for retrieving or downloading records and photos already uploaded to WEBCEPH.
Beta service: The WEBCEPH Partner API is currently provided free of charge as a beta service and is planned to transition to a paid service based on API usage in the future.

Request Limit

WEBCEPH User: 30 requests/minute

API Services

API Status

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

Get User Info

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

Get Patient List

Retrieves the latest 10 items in order of updated date
Search by Name
Search by Patient ID
Search by both name or Patient ID

[
    {
        "patientid": "webceph-sample-001",
        "firstname": "Albert",
        "lastname": "Kim",
        "gender": "male", // Lower case
        "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/";
    }
]

Get a List of Records

Get a list of records for the patient by sending Patient ID information

{
    "firstname": "Albert",
    "lastname": "Kim",
    "birthdate": "2000-01-01",
    "records": [
        {
            "recorddate": "2024-01-10", // The latest record is at the top of the list
            "recordhash": "2024-01-10"
        },
        ....
    ],
    "linkid": "Y7zv7pFl950eGk",
    "link": "https://webceph.com/records/Y7zv7pFl950eGk/"
}

Create a New Patient

Add new patient information by sending Patient ID, last name, first name, race, gender, and birthday

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

Add New Record

Add new record by sending Patient ID, recording date

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

Upload Image

Upload a single image file to a specific record for a specific patient
Upload by sending Patient ID, record date, photo type and photo data.

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