UDENTIVA Plataforma Inteligente de Gestão Odontológica

Comece Grátis

DESENVOLVEDORES

Documentação da API UDENTIVA

Integre com segurança os dados da sua clínica aos seus próprios sistemas. Uma API baseada em REST, consistente e previsível.

Acesso externo à API em breve

Os endpoints abaixo são o escopo completo que será exposto. Entre em contato para acesso antecipado.

Modelo de Segurança da API

Isolamento de dados, gravação idempotente, consulta parametrizada — segurança baseada no código. →

Visão Geral

A API UDENTIVA segue os princípios REST; usa corpo em JSON e retorna códigos de status HTTP padrão. Todas as requisições são feitas por HTTPS e autenticadas por chave de API. Cada requisição é limitada aos dados da clínica à qual a chave está vinculada (isolamento total de dados).

Endereço base:

https://api.udentiva.com

Autenticação

Nas requisições, envie sua chave de API no cabeçalho Authorization. As chaves são geradas pelo painel da clínica e podem ser revogadas quando você quiser.

# Exemplo de requisição
curl https://api.udentiva.com/v1/patients \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Accept: application/json"

Endpoints

81 endpoint · 12 fonte

Abaixo estão todos os endpoints que serão expostos. Na página de detalhe de cada recurso há parâmetros, exemplo de requisição/resposta e notas de segurança. Os endpoints de gravação suportam o cabeçalho Idempotency-Key.

Pacientes · 9

Detalhes e exemplo →

GET /v1/patients Obtém a lista de pacientes de forma paginada

POST /v1/patients Cria um novo registro de paciente

GET /v1/patients/{id} Obtém os detalhes de um único paciente

PUT /v1/patients/{id} Atualiza as informações do paciente

DELETE /v1/patients/{id} Arquiva o paciente (soft-delete)

GET /v1/patients/{id}/medical Lista anamnese, alergias e histórico médico

POST /v1/patients/{id}/medical Adiciona um registro médico/de anamnese

GET /v1/patients/{id}/documents Lista os documentos do paciente

POST /v1/patients/{id}/documents Adiciona um documento ao paciente

Agendamentos e calendário · 10

Detalhes e exemplo →

GET /v1/appointments Lista as consultas por intervalo de datas

POST /v1/appointments Cria uma nova consulta (com verificação de conflito)

POST /v1/appointments/{id}/status Altera o status da consulta

POST /v1/appointments/{id}/reschedule Reagenda a consulta

POST /v1/appointments/{id}/remind Envia lembrete de consulta

GET /v1/units Lista as cadeiras/unidades

GET /v1/doctors Lista os médicos

GET /v1/waitlist Obtém a lista de espera

POST /v1/waitlist Adiciona paciente à lista de espera

DELETE /v1/waitlist/{id} Remove da lista de espera

Odontograma & Tratamento · 14

Detalhes e exemplo →

GET /v1/patients/{id}/odontogram Obtém o odontograma FDI atual

POST /v1/patients/{id}/odontogram Adiciona estado do dente (append-only)

GET /v1/patients/{id}/odontogram/{tooth}/history Obtém o histórico de estado de um dente

GET /v1/services Lista o catálogo de serviços/procedimentos

POST /v1/services Adiciona um item de serviço

PUT /v1/services/{id} Atualiza o item de serviço

GET /v1/patients/{id}/plans Lista os planos de tratamento do paciente

POST /v1/patients/{id}/plans Cria um plano de tratamento

GET /v1/plans/{id} Obtém os detalhes do plano de tratamento

POST /v1/plans/{id}/status Altera o status do plano

POST /v1/plans/{id}/items Adiciona etapa/item ao plano

POST /v1/plan-items/{id}/status Altera o status do item do plano

GET /v1/patients/{id}/prescriptions Lista as prescrições

POST /v1/patients/{id}/prescriptions Cria uma prescrição

Cobrança e Finanças · 12

Detalhes e exemplo →

POST /v1/invoices Cria uma fatura

GET /v1/invoices Lista as faturas

GET /v1/invoices/{id} Obtém os detalhes da fatura

POST /v1/invoices/{id}/void Cancela a fatura (lançamento reverso)

POST /v1/invoices/{id}/einvoice Envia a fatura como e-Fatura (GİB)

GET /v1/einvoices Lista os registros de e-Fatura

POST /v1/payments Registra uma cobrança (idempotente)

GET /v1/patients/{id}/balance Obtém o saldo corrente do paciente

GET /v1/patients/{id}/ledger Lista os movimentos de conta-corrente do paciente

GET /v1/cash/day Obtém o resumo de caixa do fechamento de dia

GET /v1/cari Lista os saldos correntes (conta-corrente)

GET /v1/billing/summary Obtém o resumo financeiro/de cobranças

Estoque · 6

Detalhes e exemplo →

GET /v1/stock Lista as fichas de estoque

GET /v1/stock/critical Lista os itens de estoque em nível crítico

POST /v1/stock Cria uma ficha de estoque

PUT /v1/stock/{id} Atualiza a ficha de estoque

POST /v1/stock/{id}/movement Adiciona um movimento de estoque (entrada/saída)

GET /v1/stock/{id}/movements Lista os movimentos de estoque

Imagem · 3

Detalhes e exemplo →

GET /v1/patients/{id}/images Lista as imagens do paciente (radiografias/fotos)

POST /v1/patients/{id}/images Envia imagem (S3, stream/presigned)

GET /v1/images/{id}/raw Baixa o arquivo de imagem (presigned)

Laboratório · 7

Detalhes e exemplo →

GET /v1/lab-orders Lista os pedidos de laboratório

POST /v1/lab-orders Cria um pedido de laboratório

GET /v1/lab-orders/{id} Obtém os detalhes do pedido

PUT /v1/lab-orders/{id} Atualiza o pedido

POST /v1/lab-orders/{id}/status Altera o status do pedido

GET /v1/labs Lista os laboratórios conveniados

POST /v1/labs Adiciona um laboratório

Lead & CRM · 7

Detalhes e exemplo →

GET /v1/leads Lista os leads/solicitações

POST /v1/leads Cria um novo lead

POST /v1/leads/{id}/status Altera o status/etapa do lead

GET /v1/tasks Lista as tarefas

POST /v1/tasks Cria uma tarefa

GET /v1/messages Lista as mensagens de comunicação do paciente

POST /v1/messages Cria um registro de mensagem/comunicação

Turismo de saúde · 5

Detalhes e exemplo →

GET /v1/tourism-cases Lista os casos de turismo de saúde

POST /v1/tourism-cases Cria um caso de turismo

POST /v1/tourism-cases/{id}/status Altera a etapa do caso

GET /v1/shipments Lista os registros de transferência/envio

POST /v1/shipments Cria um registro de transferência/envio

Relatórios & BI · 3

Detalhes e exemplo →

GET /v1/bi Obtém as métricas de business intelligence

GET /v1/profit Obtém o relatório de rentabilidade

GET /v1/rcm Obtém as métricas do ciclo de receita (RCM)

Webhooks · 3

Detalhes e exemplo →

GET /v1/webhooks Lista as assinaturas de webhook registradas

POST /v1/webhooks Registra um webhook para notificação de eventos

DELETE /v1/webhooks/{id} Exclui a assinatura de webhook

Transferência de Dados (Export API) · 2

Detalhes e exemplo →

GET /export/v1 Retorna os conjuntos de dados permitidos e as informações de uso da chave (descoberta)

GET /export/v1/{dataset} Extrai o conjunto de dados selecionado de forma paginada (?limit=1000&offset=0)

Formato de Erro

Os erros retornam em um envelope consistente; o código é destinado à máquina, a mensagem ao usuário. Erro interno/stack nunca é vazado.

{
  "error": {
    "code": "validation_failed",
    "message": "Campo inválido: e-mail"
  }
}

Limite de Taxa

As requisições são limitadas por minuto. Quando o limite é excedido, retorna 429; os cabeçalhos de resposta carregam a informação da cota restante.

Versionamento

A versão da API é transportada no caminho (ex.: /v1). Alterações que quebram a compatibilidade retroativa são publicadas em uma nova versão.

Eventos de Webhook

Conforme os eventos ocorrem na sua clínica, uma notificação assinada é enviada ao seu endereço cadastrado. Assim, você mantém seu próprio sistema atualizado em tempo real.

# Exemplos de tipos de evento
patient.created   appointment.created   appointment.status_changed
invoice.created   payment.created       lab_order.status_changed
treatment_plan.updated   lead.created   tourism_case.status_changed

Deseja acesso antecipado?

Seja o primeiro a saber quando a API for lançada.

Entre em Contato