WEBCEPH API

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.

Request Limit

• WEBCEPH User: 30 requests/minute

API Services

API Status

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

Get Record Detail

• Get details of the record by sending Patient ID, record date

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

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",
    "big": "Image URL",
    "thumbnail": "Image URL",
    "linkid": "Adzv7pFl95234k",
    "link": "https://webceph.com/records/Adzv7pFl95234k/"
}