WEBCEP API

Dit document is een API-handboek voor communicatie en integratie tussen WEBCEPH en partnersoftware van derde partijen (hierna genoemd: Partner Software. Voorbeelden van communicatie en verbinding met partners zijn als volgt:

• Patiëntbeheersoftware:
  Klik de WEBCEPH kortkoort op de patiëntbeheersoftware om de patiënt te bekijken en te analyseren's analysegegevens over WEBCEPH.
• Dental Imaging Software:
  Maakt en analyseer patiënten door WEBCEPH directe upload op de tandbeeldsoftware te klikken.

De voorwaarden en procedures voor de verbinding tussen software zijn als volgt:

• Partner API-sleutel zullen worden uitgegeven aan partners met wie de integratie is overeengekomen.
  (API-key wordt door versie of periode veranderd om veiligheid te bewaren. Wanneer nodig zijn voor veiligheidsdoeleinden, zullen partners vooraf worden aangegeven.)
• De integratiefunctie met Partner Software wordt verstrekt aan de lidstaten van WEBCEPH Premium niveau of hoger. Goedkeuring: API-toegang vereist voorafgaande goedkeuring van WEBCEPH. Een abonnement alleen geeft geen recht op API-toegang.
• Wij verstrekken via de API geen referentiepunten, analyseresultaten of andere klinische en diagnostische informatie.
• Om redenen van bescherming van patiëntgegevens en beveiliging wordt het exporteren van afbeeldingen (inclusief originele afbeeldingen, verkleinde afbeeldingen en miniaturen) niet via de API aangeboden.
• Gebruiksbeperkingen: De Partner API mag niet worden gebruikt voor het in bulk opvragen van WEBCEPH-patiëntgegevens of patiëntenlijsten, of voor het opvragen of downloaden van dossiers en foto's die al naar WEBCEPH zijn geüpload.
• Bètadienst: De WEBCEPH Partner API wordt momenteel gratis aangeboden als bètadienst en zal in de toekomst overgaan naar een betaalde dienst op basis van API-gebruik.

Verzoeklimiet

• WEBCEPH Gebruikers: 30 verzoeken/minuten

API-diensten

API-status

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

Gebruikersinformatie ontvangen

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

Patiëntenlijst krijgen

• De nieuwste 10 items ontvangen in volgorde van de opgewerkte datum
• Zoek naar naam
• Zoek door patiënt ID
• Zoek naar naam of patiënt ID

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

Een lijst van Records

• Een lijst van registraties voor de patiënt door de patiënt ID-informatie te verzenden

{
    "firstname": "Albert",
    "lastname": "Kim",
    "birthdate": "2000-01-01",
    "records": [
        {
            "recorddate": "2024-01-10", // De laatste record is op de bovenste van de lijst
            "recordhash": "2024-01-10"
        },
        ....
    ],
    "linkid": "Y7zv7pFl950eGk",
    "link": "https://webceph.com/records/Y7zv7pFl950eGk/"
}

Een nieuwe patiënt maken

• Nieuwe patiënten informatie toevoegen door patiënt-ID te verzenden, naam, eerste naam, race, geslag en geboortejaard

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

nieuwe record toevoegen

• Nieuwe registre toevoegen door patiënten-ID te verzenden, opnemingdatum

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

Opladen afbeelding

• Opladen een enkele bestand naar een specifieke record voor een specifieke patiënt
• Upload door Patiënt ID te verzenden, opnemingsdatum, fototype en fotodata.

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