API DE WEBCEF

Este documento é um manual API para a comunicação e integração entre WEBCEPH e software parceiro de terceiros (a seguir denominado: Software Parceiro). Exemplos de utilização de comunicação e ligação com parceiros são seguintes:

• Software de gestão dos pacientes:
  Clique no ataque de WEBCEP no software de gestão do paciente para ver e analisar o paciente'dados de análise sobre WEBCEPH.
• Software de Imaging Dental:
  Criar e analisar pacientes cliquendo a escalar diretamente no software de imagem dental.

As condições e os procedimentos de ligação entre software são seguintes:

• Chave API Parceiro será emitido aos parceiros com os que sejam acordos a integração.
  (A API Key será alterada por versão ou período para manter a segurança. Quando seja necessárias alterações para fins de segurança, os parceiros serão notificados em anterioridade.)
• A função de integração com software Parceiros é fornecida aos membros de Premium WEBCEPH nível ou maior. Aprovação: O acesso à API exige aprovação prévia da WEBCEPH. O plano de assinatura, por si só, não concede acesso à API.
• Não fornecemos pela API pontos de referência, resultados de análises ou outras informações clínicas e de diagnóstico.
• Por motivos de proteção de dados dos pacientes e de segurança, a exportação de imagens (incluindo imagens originais, redimensionadas e miniaturas) não é fornecida pela API.
• Restrições de uso: A Partner API não pode ser usada para consulta em massa de informações ou listas de pacientes do WEBCEPH, nem para consultar ou baixar registros e fotos já enviados ao WEBCEPH.
• Serviço beta: A WEBCEPH Partner API é atualmente oferecida gratuitamente como serviço beta e está prevista a sua transição futura para um serviço pago baseado no uso da API.

Limite de pedido

• User WEBCEPH: 30 pedidos/minutos

Serviços API

Estado da API

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

Obter informações do usuário

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

Obter lista dos pacientes

• Recupera os últimos 10 itens em ordem da data actualizada
• Procurar por nome
• Procura por ID do paciente
• Procurar por nome ou ID do paciente

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

Obter uma lista de Recordos

• Obter uma lista de registros para o paciente enviar informações de identificação do paciente

{
    "firstname": "Albert",
    "lastname": "Kim",
    "birthdate": "2000-01-01",
    "records": [
        {
            "recorddate": "2024-01-10", // O último registro está na topa da lista
            "recordhash": "2024-01-10"
        },
        ....
    ],
    "linkid": "Y7zv7pFl950eGk",
    "link": "https://webceph.com/records/Y7zv7pFl950eGk/"
}

Criar um Novo paciente

• Adicionar novas informações do paciente mediante a enviar ID do paciente, nome, primeiro nome, raça, gênero e aniversário

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

Adicionar novo registro

• Adicionar novo registro por meio de enviar ID do paciente, data de gravação

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

Carregar Imagem

• Envio um único ficheiro de imagem para um registro específico para um paciente específico
• Envio por envio ID do paciente, data de registro, tipo de foto e dados de foto.

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