API RESTful completa com mais de 150 endpoints, autenticação OAuth 2.0 e webhooks para eventos em tempo real. Construída para desenvolvedores.
A API DrView permite integração completa com todos os módulos do sistema, incluindo gestão de pacientes, agendamentos, prontuário eletrônico, faturamento e muito mais. Todos os endpoints retornam JSON e aceitam JSON no corpo das requisições.
https://api.drview.com.br/v1 # API Principal https://login.drview.com.br/api # Autenticação https://pay.drview.com.br/api # Gateway de Pagamento https://diags.drview.com.br/webhook # Webhooks de Laboratórios https://farma.drview.com.br/api # Integração Farmácias
curl -X GET https://api.drview.com.br/v1/pacientes \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "X-Clinic-ID: CLINIC_UUID" \ -H "Content-Type: application/json"
O DrView usa autenticação OAuth 2.0 com suporte a certificado digital ICP-Brasil para operações sensíveis como assinatura de prescrições e prontuários.
Authorization: Bearer YOUR_ACCESS_TOKEN X-Clinic-ID: YOUR_CLINIC_UUID X-Certificate: BASE64_CERTIFICATE # para operações sensíveis
Autentica usando CPF/CNPJ e senha ou certificado digital.
{
"cpf_cnpj": "12345678900",
"password": "senha_segura",
"clinic_id": "uuid-da-clinica",
"grant_type": "password"
}Lista todos os pacientes da clínica com paginação e busca por nome ou CPF.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| page | integer | Não | Número da página (padrão: 1) |
| per_page | integer | Não | Itens por página (máx: 100) |
| search | string | Não | Busca por nome ou CPF |
{
"data": [
{
"id": "pac_uuid_123",
"nome": "João Silva",
"cpf": "123.456.789-00",
"data_nascimento": "1985-03-15",
"telefone": "(11) 98765-4321",
"email": "joao@email.com",
"convenio": {
"nome": "Unimed",
"numero_carteira": "123456789"
},
"alergias": ["Dipirona", "Penicilina"],
"ultimo_atendimento": "2024-01-15T14:30:00Z"
}
],
"meta": {
"current_page": 1,
"total_pages": 10,
"total_items": 245,
"per_page": 25
}
}Cadastra um novo paciente no sistema.
{
"nome": "Maria Santos",
"cpf": "987.654.321-00",
"data_nascimento": "1990-07-20",
"sexo": "F",
"telefone": "(11) 91234-5678",
"email": "maria@email.com",
"endereco": {
"cep": "01310-100",
"logradouro": "Av. Paulista",
"numero": "1000",
"bairro": "Bela Vista",
"cidade": "São Paulo",
"uf": "SP"
}
}Cria um novo agendamento de consulta com confirmação automática via WhatsApp.
{
"paciente_id": "pac_uuid_123",
"profissional_id": "dr_uuid_456",
"data_hora": "2024-02-01T14:00:00Z",
"tipo_atendimento": "presencial",
"duracao_minutos": 30,
"convenio": true,
"observacoes": "Primeira consulta",
"enviar_lembrete": true
}Verifica horários disponíveis para agendamento de um profissional em uma data.
Cria uma prescrição digital assinada com certificado ICP-Brasil e envia para a farmácia escolhida.
{
"paciente_id": "pac_uuid_123",
"atendimento_id": "atd_uuid_789",
"medicamentos": [
{
"nome": "Amoxicilina 500mg",
"posologia": "1 comprimido de 8/8h por 7 dias",
"quantidade": "21 comprimidos"
}
],
"enviar_farmacia": true,
"farmacia_id": "farm_uuid_321",
"assinatura_digital": "base64_signature"
}Solicite exames laboratoriais e de imagem, e receba os resultados automaticamente via webhook quando estiverem disponíveis.
Cria uma solicitação de exame para um laboratório ou centro de imagem parceiro.
Obtém o resultado de um exame, incluindo URL de download do laudo em PDF.
Gerencie cobranças, gere QR Codes PIX dinâmicos, processe cartões e consulte o histórico financeiro da clínica.
Gera um QR Code PIX dinâmico com expiração configurável e conciliação automática.
Retorna o extrato financeiro da clínica com filtros por período e forma de pagamento.
Configure webhooks para receber notificações em tempo real sobre eventos do sistema em sua URL.
patient.created — Novo paciente cadastradoappointment.scheduled — Consulta agendadaappointment.confirmed — Consulta confirmada via WhatsAppexam.result — Resultado de exame disponívelpayment.received — Pagamento processadoprescription.sent — Receita enviada para farmácia{
"event": "exam.result",
"timestamp": "2024-01-20T10:30:00Z",
"data": {
"patient_id": "pac_uuid_123",
"exam_id": "exam_uuid_456",
"lab_id": "lab_uuid_789",
"status": "ready",
"download_url": "https://diags.drview.com.br/results/exam_uuid_456"
},
"signature": "hmac_sha256_signature"
}Limites de requisições por plano para garantir a qualidade do serviço para todos os clientes.
X-RateLimit-Limit: 5000 X-RateLimit-Remaining: 4998 X-RateLimit-Reset: 1640995200
Acelere sua integração com nossos SDKs oficiais. Todos com suporte completo, exemplos e documentação inline.