RaciMED API V2.14

Documentação API RaciMED - V2.14

rAPI Versão: 1.2.3

Endereço exemplo: https://cliente.racimednuvem.com.br:90000/(endpoints)

API privada por clienteEndpoints habilitados mediante autorizaçãoGET e POSTSwagger Style34 endpoints documentados
Cada cliente possui um endereço fixo de acesso. Os endpoints são habilitados somente após autorização do cliente. Esta documentação não representa uma API pública.
Novidades / conferência V2.14
  • Atualizada para Documentação V2.14 e rAPI 1.2.3.
  • Incluído/confirmado o endpoint GET /agendascodpac/:id_codpac para listar agendamentos por código do paciente.
  • Confirmados endpoints de lembretes, agendas enviadas e agendas ocupadas por intervalo.
  • O endpoint POST /funcionarios aparece apenas comentado no fonte atual, por isso não foi listado como endpoint ativo.
Configuração rápida

Use a Base URL do cliente e autenticação Basic Auth conforme configurado no arquivo INI do servidor.

Headers recomendados
Accept: application/json
Content-Type: application/json
Authorization: Basic BASE64(usuario:senha)
Exemplo Delphi 7 / Chilkat — GET /medicos
var
  rest: HCkRest;
  ok: Boolean;
  resp: PWideChar;
begin
  rest := CkRest_Create;
  try
    ok := CkRest_Connect(rest,'cliente.racimednuvem.com.br',90000,True,True);
    if not ok then Exit;

    CkRest_AddHeader(rest,'Accept','application/json');
    // CkRest_SetAuthBasic(rest,'usuario','senha');

    resp := CkRest__fullRequestNoBody(rest,'GET','/medicos');
    Memo1.Lines.Text := resp;
  finally
    CkRest_Dispose(rest);
  end;
end;

Sistema

GET/ping

Teste/status do servidor RaciMED API; retorna HTML com data/hora e versão da API.

Controller: rAPI.dpr   Handler: procedure

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/ping" -H "Accept: application/json"
Retorno exemplo
<html>RaciMED.API Server... Versão da API: 1.2.3</html>
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno

Médicos

GET/medicos

Lista os profissionais/médicos cadastrados.

Controller: Controller.medicos.pas   Handler: ListarMedicos

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/medicos" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/medicosespecialidades

Lista especialidades dos profissionais.

Controller: Controller.medicos.pas   Handler: ListarMedicosEspecialidades

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/medicosespecialidades" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/medicoshorarios

Lista profissionais com configuração de horários.

Controller: Controller.medicos.pas   Handler: ListarMedicosHorarios

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/medicoshorarios" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/medicoshorarios/:idprof

Lista horários do profissional informado.

Controller: Controller.medicos.pas   Handler: ListarMedicosHorarios

Parâmetros
NomeLocalTipoObservação
idprofpathstringCódigo do profissional/médico.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/medicoshorarios/11" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno

Pacientes

GET/pacientes/:id

Consulta paciente por CPF. O parâmetro aceita CPF com ou sem máscara.

Controller: Controller.pacientes.pas   Handler: ListarPacientesCPF

Parâmetros
NomeLocalTipoObservação
idpathstringCódigo/identificador conforme endpoint.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/pacientes/1" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/pacientesID/:id

Consulta paciente pelo código interno.

Controller: Controller.pacientes.pas   Handler: ListarPacientesID

Parâmetros
NomeLocalTipoObservação
idpathstringCódigo/identificador conforme endpoint.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/pacientesID/1" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/pacientesCEL/:cel

Consulta paciente pelo celular.

Controller: Controller.pacientes.pas   Handler: ListarPacientesCELULAR

Parâmetros
NomeLocalTipoObservação
celpathstringNúmero do celular, preferencialmente só dígitos.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/pacientesCEL/11981848560" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/pacientesCART/:cart

Consulta paciente por carteira do convênio.

Controller: Controller.pacientes.pas   Handler: ListarPacientesCART

Parâmetros
NomeLocalTipoObservação
cartpathstringNúmero da carteira do convênio.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/pacientesCART/ABC123456" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/pacientesaniversariantes/:data

Lista pacientes aniversariantes pela data informada.

Controller: Controller.pacientes.pas   Handler: ListarPacientesAniversario

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/pacientesaniversariantes/2026-04-16" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno

Agendas

GET/agendas

Lista agendas cadastradas.

Controller: COntroller.agendas.pas   Handler: ListaAgendas

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendas" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendas/:id

Lista agendas por data ou profissional, conforme parâmetro informado.

Controller: COntroller.agendas.pas   Handler: ListaAgendasDATA

Parâmetros
NomeLocalTipoObservação
idpathstringCódigo/identificador conforme endpoint.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendas/1" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendas/:data/:idprof

Lista agendas de uma data para um profissional.

Controller: COntroller.agendas.pas   Handler: ListaAgendasDATA_PROF

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
idprofpathstringCódigo do profissional/médico.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendas/2026-04-16/11" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendas/livres/:data/:idprof

Lista horários livres/ocupados do profissional na data.

Controller: COntroller.agendas.pas   Handler: ListaAgendasLIVRES

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
idprofpathstringCódigo do profissional/médico.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendas/livres/2026-04-16/11" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendas/solivres/:data/:idprof

Lista somente horários livres do profissional na data.

Controller: COntroller.agendas.pas   Handler: ListaAgendasSOLIVRES

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
idprofpathstringCódigo do profissional/médico.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendas/solivres/2026-04-16/11" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendasid/:id_agenda

Consulta agenda pelo ID do agendamento.

Controller: COntroller.agendas.pas   Handler: ListaAgendasID

Parâmetros
NomeLocalTipoObservação
id_agendapathstringID do agendamento.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendasid/12345" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendascodpac/:id_codpac

Lista agendamentos vinculados ao código do paciente. Novo na documentação V2.14 / API 1.2.3.

Controller: COntroller.agendas.pas   Handler: ListaAgendasCODPAC

Parâmetros
NomeLocalTipoObservação
id_codpacpathstringCódigo interno do paciente.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendascodpac/9999" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendascomparecimento/:data

Lista agendas com comparecimento na data.

Controller: COntroller.agendas.pas   Handler: ListaAgendasComparecimento

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendascomparecimento/2026-04-16" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendascomparecimento/:data/:idprof

Lista agendas com comparecimento por data e profissional.

Controller: COntroller.agendas.pas   Handler: ListaAgendasComparecimento

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
idprofpathstringCódigo do profissional/médico.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendascomparecimento/2026-04-16/11" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendasnaocomparecimento/:data

Lista agendas de não comparecimento na data.

Controller: COntroller.agendas.pas   Handler: ListaAgendasNaoComparecimento

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendasnaocomparecimento/2026-04-16" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendasnaocomparecimento/:data/:idprof

Lista agendas de não comparecimento por data e profissional.

Controller: COntroller.agendas.pas   Handler: ListaAgendasNaoComparecimento

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
idprofpathstringCódigo do profissional/médico.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendasnaocomparecimento/2026-04-16/11" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendasocupadas/:idprof/:data

Lista horários ocupados do profissional em uma data.

Controller: COntroller.agendas.pas   Handler: ListaAgendasOcupadas

Parâmetros
NomeLocalTipoObservação
idprofpathstringCódigo do profissional/médico.
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendasocupadas/11/2026-04-16" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendasocupadas/:idprof/:data/:data2

Lista horários ocupados do profissional em intervalo de datas.

Controller: COntroller.agendas.pas   Handler: ListaAgendasOcupadas

Parâmetros
NomeLocalTipoObservação
idprofpathstringCódigo do profissional/médico.
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
data2pathstringData final no formato AAAA-MM-DD.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendasocupadas/11/2026-04-16/2026-04-162" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendaslembretes/:id

Lista agendas para lembretes por parâmetro informado.

Controller: COntroller.agendas.pas   Handler: ListaAgendaslembretesDATA

Parâmetros
NomeLocalTipoObservação
idpathstringCódigo/identificador conforme endpoint.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendaslembretes/1" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendasenviadas/:id

Marca agenda como enviada/avisada pela API.

Controller: COntroller.agendas.pas   Handler: MarcarsAgendasEnviadas

Parâmetros
NomeLocalTipoObservação
idpathstringCódigo/identificador conforme endpoint.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendasenviadas/1" -H "Accept: application/json"
Retorno exemplo
HTTP 200 quando executado sem erro.
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/tiposdeatendimentos

Lista tipos de atendimento.

Controller: COntroller.agendas.pas   Handler: ListaTipos

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/tiposdeatendimentos" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendaconfirmacao/:id

Confirma um agendamento pelo ID.

Controller: COntroller.agendas.pas   Handler: ConfirmarHorario

Parâmetros
NomeLocalTipoObservação
idpathstringCódigo/identificador conforme endpoint.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendaconfirmacao/1" -H "Accept: application/json"
Retorno exemplo
HTTP 200 quando executado sem erro.
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/agendadesconfirmacao/:id

Remove/desfaz confirmação do agendamento pelo ID.

Controller: COntroller.agendas.pas   Handler: DesconfirmarHorario

Parâmetros
NomeLocalTipoObservação
idpathstringCódigo/identificador conforme endpoint.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/agendadesconfirmacao/1" -H "Accept: application/json"
Retorno exemplo
HTTP 200 quando executado sem erro.
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/desmarcarhorario/:id

Desmarca/cancela um horário pelo ID.

Controller: COntroller.agendas.pas   Handler: DesmarcaHorario

Parâmetros
NomeLocalTipoObservação
idpathstringCódigo/identificador conforme endpoint.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/desmarcarhorario/1" -H "Accept: application/json"
Retorno exemplo
HTTP 200 quando executado sem erro.
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/elegibilidaderetorno/:data/:idprof/:id/:idconv

Verifica elegibilidade de retorno para paciente, profissional, data e convênio.

Controller: COntroller.agendas.pas   Handler: ElegibilidadeRetorno

Parâmetros
NomeLocalTipoObservação
datapathstringData no formato AAAA-MM-DD. Ex.: 2026-04-16
idprofpathstringCódigo do profissional/médico.
idpathstringCódigo/identificador conforme endpoint.
idconvpathstringCódigo do convênio.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/elegibilidaderetorno/2026-04-16/11/1/1conv" -H "Accept: application/json"
Retorno exemplo
[]
ou
["05/04/2026"]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
POST/agendarhorario

Inclui um novo agendamento.

Controller: COntroller.agendas.pas   Handler: AgendaHorario

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Body JSON
{
  "codpac": 0,
  "paciente": "NOME DO PACIENTE COMPLETO",
  "data": "2026-04-16",
  "hora": "11:00",
  "codmed": 11,
  "codexame": 1,
  "fone1": "(11) 98184-8560",
  "codtipo": 1,
  "tipo": "1ª vez",
  "codconv": 1,
  "codplano": 1,
  "carteira": ""
}
Exemplo cURL
curl -u usuario:senha -X POST "https://cliente.racimednuvem.com.br:90000/agendarhorario" -H "Accept: application/json" -H "Content-Type: application/json" -d '{"codpac": 0, "paciente": "NOME DO PACIENTE COMPLETO", "data": "2026-04-16", "hora": "11:00", "codmed": 11, "codexame": 1, "fone1": "(11) 98184-8560", "codtipo": 1, "tipo": "1ª vez", "codconv": 1, "codplano": 1, "carteira": ""}'
Retorno exemplo
{
  "ID agendamento : ": "12345"
}
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
201Criado

Convênios e Planos

GET/convenios

Lista convênios cadastrados e ativos.

Controller: Controller.convenios.pas   Handler: ListaConvenios

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/convenios" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/planos

Lista planos cadastrados.

Controller: Controller.convenios.pas   Handler: Listaplanos

Parâmetros
NomeLocalTipoObservação
Sem parâmetros de rota.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/planos" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
GET/planos/:ID

Lista planos filtrados por convênio/ID informado.

Controller: Controller.convenios.pas   Handler: ListaplanosID

Parâmetros
NomeLocalTipoObservação
IDpathstringCódigo do convênio/ID informado.
Exemplo cURL
curl -u usuario:senha -X GET "https://cliente.racimednuvem.com.br:90000/planos/1" -H "Accept: application/json"
Retorno exemplo
[
  {
    "campo": "valor"
  }
]
Retornos previstos
StatusDescrição
200Sucesso
400Parâmetros inválidos
401Não autorizado
500Erro interno
Erros / HTTP
StatusSignificadoExemplos
200OKConsulta executada
201CriadoAgendamento incluído
400Bad RequestData não informada, profissional inválido, JSON malformado
401UnauthorizedUsuário/senha inválidos no Basic Auth
500Erro internoFalha de conexão ou erro de banco
Mensagens comuns:
Data não informada.
Profissional inválido ou não informado.
Erro ao consultar horários livres.
Erro ao listar paciente por CPF.
OpenAPI JSON

Especificação OpenAPI 3.0.3 embutida para conferência ou importação.

{
  "openapi": "3.0.3",
  "info": {
    "title": "API RaciMED",
    "version": "1.2.3",
    "description": "Documentação Swagger Style V2.14 gerada a partir do ZIP rAPIV_123.zip"
  },
  "servers": [
    {
      "url": "http://localhost:9000",
      "description": "Ambiente local"
    },
    {
      "url": "https://racimed.api:90001",
      "description": "Ambiente cliente HTTPS"
    },
    {
      "url": "https://cliente.racimednuvem.com.br:90000",
      "description": "Modelo por cliente"
    }
  ],
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/ping": {
      "get": {
        "tags": [
          "Sistema"
        ],
        "summary": "Teste/status do servidor RaciMED API; retorna HTML com data/hora e versão da API.",
        "description": "Controller: rAPI.dpr | Handler: procedure",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/medicos": {
      "get": {
        "tags": [
          "Médicos"
        ],
        "summary": "Lista os profissionais/médicos cadastrados.",
        "description": "Controller: Controller.medicos.pas | Handler: ListarMedicos",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/medicosespecialidades": {
      "get": {
        "tags": [
          "Médicos"
        ],
        "summary": "Lista especialidades dos profissionais.",
        "description": "Controller: Controller.medicos.pas | Handler: ListarMedicosEspecialidades",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/medicoshorarios": {
      "get": {
        "tags": [
          "Médicos"
        ],
        "summary": "Lista profissionais com configuração de horários.",
        "description": "Controller: Controller.medicos.pas | Handler: ListarMedicosHorarios",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/medicoshorarios/{idprof}": {
      "get": {
        "tags": [
          "Médicos"
        ],
        "summary": "Lista horários do profissional informado.",
        "description": "Controller: Controller.medicos.pas | Handler: ListarMedicosHorarios",
        "parameters": [
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/pacientes/{id}": {
      "get": {
        "tags": [
          "Pacientes"
        ],
        "summary": "Consulta paciente por CPF. O parâmetro aceita CPF com ou sem máscara.",
        "description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesCPF",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/pacientesID/{id}": {
      "get": {
        "tags": [
          "Pacientes"
        ],
        "summary": "Consulta paciente pelo código interno.",
        "description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesID",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/pacientesCEL/{cel}": {
      "get": {
        "tags": [
          "Pacientes"
        ],
        "summary": "Consulta paciente pelo celular.",
        "description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesCELULAR",
        "parameters": [
          {
            "name": "cel",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/pacientesCART/{cart}": {
      "get": {
        "tags": [
          "Pacientes"
        ],
        "summary": "Consulta paciente por carteira do convênio.",
        "description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesCART",
        "parameters": [
          {
            "name": "cart",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/pacientesaniversariantes/{data}": {
      "get": {
        "tags": [
          "Pacientes"
        ],
        "summary": "Lista pacientes aniversariantes pela data informada.",
        "description": "Controller: Controller.pacientes.pas | Handler: ListarPacientesAniversario",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendas": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendas cadastradas.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendas",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendas/{id}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendas por data ou profissional, conforme parâmetro informado.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasDATA",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendas/{data}/{idprof}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendas de uma data para um profissional.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasDATA_PROF",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendas/livres/{data}/{idprof}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista horários livres/ocupados do profissional na data.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasLIVRES",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendas/solivres/{data}/{idprof}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista somente horários livres do profissional na data.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasSOLIVRES",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendasid/{id_agenda}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Consulta agenda pelo ID do agendamento.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasID",
        "parameters": [
          {
            "name": "id_agenda",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendascodpac/{id_codpac}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendamentos vinculados ao código do paciente. Novo na documentação V2.14 / API 1.2.3.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasCODPAC",
        "parameters": [
          {
            "name": "id_codpac",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendascomparecimento/{data}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendas com comparecimento na data.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasComparecimento",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendascomparecimento/{data}/{idprof}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendas com comparecimento por data e profissional.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasComparecimento",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendasnaocomparecimento/{data}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendas de não comparecimento na data.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasNaoComparecimento",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendasnaocomparecimento/{data}/{idprof}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendas de não comparecimento por data e profissional.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasNaoComparecimento",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendasocupadas/{idprof}/{data}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista horários ocupados do profissional em uma data.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasOcupadas",
        "parameters": [
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendasocupadas/{idprof}/{data}/{data2}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista horários ocupados do profissional em intervalo de datas.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendasOcupadas",
        "parameters": [
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "data2",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendaslembretes/{id}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista agendas para lembretes por parâmetro informado.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaAgendaslembretesDATA",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendasenviadas/{id}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Marca agenda como enviada/avisada pela API.",
        "description": "Controller: COntroller.agendas.pas | Handler: MarcarsAgendasEnviadas",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/tiposdeatendimentos": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Lista tipos de atendimento.",
        "description": "Controller: COntroller.agendas.pas | Handler: ListaTipos",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendaconfirmacao/{id}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Confirma um agendamento pelo ID.",
        "description": "Controller: COntroller.agendas.pas | Handler: ConfirmarHorario",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendadesconfirmacao/{id}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Remove/desfaz confirmação do agendamento pelo ID.",
        "description": "Controller: COntroller.agendas.pas | Handler: DesconfirmarHorario",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/desmarcarhorario/{id}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Desmarca/cancela um horário pelo ID.",
        "description": "Controller: COntroller.agendas.pas | Handler: DesmarcaHorario",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/elegibilidaderetorno/{data}/{idprof}/{id}/{idconv}": {
      "get": {
        "tags": [
          "Agendas"
        ],
        "summary": "Verifica elegibilidade de retorno para paciente, profissional, data e convênio.",
        "description": "Controller: COntroller.agendas.pas | Handler: ElegibilidadeRetorno",
        "parameters": [
          {
            "name": "data",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "idprof",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "idconv",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/agendarhorario": {
      "post": {
        "tags": [
          "Agendas"
        ],
        "summary": "Inclui um novo agendamento.",
        "description": "Controller: COntroller.agendas.pas | Handler: AgendaHorario",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          },
          "201": {
            "description": "Criado"
          }
        },
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "example": {
                "codpac": 0,
                "paciente": "NOME DO PACIENTE COMPLETO",
                "data": "2026-04-16",
                "hora": "11:00",
                "codmed": 11,
                "codexame": 1,
                "fone1": "(11) 98184-8560",
                "codtipo": 1,
                "tipo": "1ª vez",
                "codconv": 1,
                "codplano": 1,
                "carteira": ""
              }
            }
          }
        }
      }
    },
    "/convenios": {
      "get": {
        "tags": [
          "Convênios e Planos"
        ],
        "summary": "Lista convênios cadastrados e ativos.",
        "description": "Controller: Controller.convenios.pas | Handler: ListaConvenios",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/planos": {
      "get": {
        "tags": [
          "Convênios e Planos"
        ],
        "summary": "Lista planos cadastrados.",
        "description": "Controller: Controller.convenios.pas | Handler: Listaplanos",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    },
    "/planos/{ID}": {
      "get": {
        "tags": [
          "Convênios e Planos"
        ],
        "summary": "Lista planos filtrados por convênio/ID informado.",
        "description": "Controller: Controller.convenios.pas | Handler: ListaplanosID",
        "parameters": [
          {
            "name": "ID",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Sucesso"
          },
          "400": {
            "description": "Parâmetros inválidos"
          },
          "401": {
            "description": "Não autorizado"
          },
          "500": {
            "description": "Erro interno"
          }
        }
      }
    }
  }
}
Copiado ✓