Passar para o conteúdo principal

API Clínica nas Nuvens

Entenda como funciona a API do Clínica nas Nuvens!

Atualizado há mais de 2 meses

Por que uma API é tão importante?

A API do Clínica nas Nuvens é essencial para integrar sistemas, automatizar processos e melhorar a experiência do paciente. Ela permite agendamentos online, listas de espera inteligentes e consultas de preços e elegibilidade, reduzindo ligações e ociosidade de agenda. No dia a dia, garante eficiência operacional ao eliminar retrabalho, padronizar fluxos e disponibilizar informações em tempo real.

Com os dados integrados, a clínica pode tomar decisões baseadas em indicadores como taxa de faltas, ocupação e conversão de orçamentos. Além disso, a API amplia o ecossistema digital, conectando teleconsulta, pagamentos, CRM e parceiros de saúde. Tudo isso com segurança e conformidade, protegendo dados e mantendo a operação confiável e moderna.

Para integrar a API pública do Clínica nas Nuvens, acesse em:

Configurações > Minha Empresa > Integrações > API Clínica nas Nuvens

Para utilizar os métodos de API, a requisição deve autenticar em formato Basic, com as credenciais internas do Clínica nas Nuvens ou com as credenciais fornecidas para o parceiro (um client_id e um client_secret), como exemplifica a imagem acima.

Caso você queira ser um parceiro de integrações e não possua as credenciais, você deve solicitá-las através do endereço suporte@clinicanasnuvens.com.br ou diretamente pelo nosso chat de atendimento. Serão solicitados alguns dados sobre seu aplicativo e, caso aprovado pela nossa equipe, suas credenciais serão criadas.

A API atende os seguintes módulos:

  • Agenda;

  • Cadastros gerais;

  • Info;

  • Lista de espera;

  • Orçamento;

  • Paciente;

  • Tratamento odontológico.

💡 Veja alguns exemplos práticos com os grupos da API:

  • Agenda
    Site/app de marcação lê disponibilidade do executor e cria/atualiza /agenda.
    “Buracos” de agenda são preenchidos via /lista-espera + alteração de status;

  • Paciente
    Lead do formulário do site vira /paciente/novo; enriquecemos com origem (/origem), validamos convênio (/plano-beneficio/elegibilidade) e associamos (/convenio-paciente);

  • Orçamento
    Integração com CRM/BI puxa /orcamento/lista para medir conversão por canal, profissional e procedimento;

  • Catálogos (especialidade/tipo-convênio/tipo-procedimento/valores)
    Exibir no site o que a clínica atende, quem atende, e estimativas de valor conforme convênio;

  • Info
    Verificação do tenant e health-check de integrações por /info;

  • Profissional de saúde escola
    Onboarding/gestão de alunos e supervisores integrado ao sistema acadêmico.

O que é possível fazer com a API?

Com a nossa API o nosso cliente vai poder interagir com o nosso sistema, conectando outros produtos e consultando informações, Criando informações ou alterando informações

Observações válidas para quase todos os endpoints:

  • Autenticação: Basic Auth (client_id/client_secret) + header obrigatório clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>.

  • Paginação (quando aplicável): pagina, registrosPorPagina.

  • Datas/horas: são strings (ex.: YYYY-MM-DD, HH:mm), conforme cada campo.

Agenda

Com os métodos de agenda você vai poder consultar todos os horários disponíveis de profissional da saúde, seus agendamentos já criados e além disso criar e alterar agendamentos. Algumas ações que a nossa API possibilita:

  1. Pegar horários livres de médicos para mostrar em ferramentas externas

  2. Pegar a lista de agendamentos para enviar em outros lugares

  3. Pegar a lista de procedimentos e valores, para que um chatbot possa mostrar o valor de consultas

  4. Alterar a situação do agendamento

  5. Entre outras coisas

  • GET /agenda-rotulo/lista — Lista rótulos de agenda. Params: pagina, registrosPorPagina.

  • PUT /agenda/alteracao-status — Altera status de uma agenda. Body: AlteracaoAgendaAPI (ex.: idAgenda, status).

  • GET /agenda/lista — Lista agendamentos por filtro. Params obrigatórios: dataInicial, dataFinal; opcionais: codigoPaciente, codigoPessoaExecutor, dataPor.

  • POST /agenda/novo — Cria agenda. Body: AgendaFormAPI.

  • GET /agenda/origem — Lista origens de pacientes ativas para agendamentos.

  • GET /agenda/profissional — Agendas resumidas de um profissional. Params: codExecutorAgenda, dataInicial, dataFinal.

  • GET /agenda/{id} — Busca agenda por ID.

  • PUT /agenda/{id} — Altera agenda por ID. Body: AgendaAlteracaoFormAPI.

  • POST /agenda/{id}/remarcar — Remarca agenda por ID. Body: AgendaRemarcacaoFormAPI.

  • GET /agenda/{id}/resumida — Busca agenda resumida por ID.

Apoio à Agenda (catálogos/auxiliares)

  • GET /especialidade/lista — Lista especialidades. Filtros: nomeContem, somenteAtendidasNaClinica, somenteAtivasNaWeb.

  • GET /especialidade/{id} — Detalhe da especialidade.

  • GET /executor-agenda/disponibilidade — Janelas disponíveis de um executor. Params: idExecutorAgenda, data (e opc. dataFim, codTipoAtendimento).

  • GET /executor-agenda/lista — Lista executores. Filtros comuns (nome, especialidade, convênio, ativos, etc.).

  • GET /executor-agenda/{id} — Executor com detalhes (quando profissional de saúde).

  • GET /local-agenda/lista — Lista “múltiplas agendas” (locais). Filtros: nomeContem, somenteAtivos.

  • GET /local-agenda/{id} — Detalhe do local de agenda.

  • GET /tipo-consulta/lista — Lista tipos de consulta. Filtros: nomeContem, somenteAtivos.

  • GET /tipo-consulta/{id} — Detalhe do tipo de consulta.

  • GET /tipo-convenio/lista — Lista tipos de convênio/planos. Filtros: nomeContem, idExecutor, somenteAtivos, somenteParticulares.

  • GET /tipo-convenio/{id} — Detalhe do tipo de convênio.

  • GET /tipo-procedimento/lista — Lista procedimentos. Filtros: idTipoConvenio, nomeContem, somenteAtivos, tipo (exames/todos).

  • GET /tipo-procedimento/{id} — Detalhe do procedimento.

  • GET /tipo-procedimento/valores-venda — Valores do procedimento em data/hora base. Params: dataBase, horaBase, idTipoConvenio, idTipoProcedimento (e opc. idEspecialidade).

Cadastros gerais

  • GET /cidade/lista — Lista cidades. Filtros: nomeContem.

  • GET /cidade/{id} — Detalhe da cidade (com estado/IBGE).

  • GET /nacionalidade/lista — Lista nacionalidades.

  • GET /nacionalidade/{id} — Detalhe da nacionalidade.

Info

  • GET /info — Retorna informações da clínica associada ao token (ClinicaRetornoAPI).

Lista de espera

Nosso cliente também pode consultar e inserir pacientes na lista de espera.

  • POST /lista-espera/novo — Inclui paciente na lista de espera. Body: ListaEsperaFormNovo.

  • GET /lista-espera/{id} — Busca registro por ID.

  • PUT /lista-espera/{id} — Altera registro por ID. Body: ListaEsperaFormEditar.

Orçamento

Será possível apenas visualizar orçamentos criados, mas não alterá-los

  • GET /orcamento/lista — Lista orçamentos por período. Params obrigatórios: dataInicial, dataFinal, tipoData (CRIACAO/APROVACAO/PREVISAO_EXECUCAO); filtros: idPaciente, status.

  • GET /orcamento/{id} — Detalhe do orçamento (procedimentos, produtos, valores, status, paciente, execuções).

Paciente

Você pode visualizar e alterar os dados do cadastro dos pacientes. No entanto, é importante ficar atento: nem todos os campos estão disponíveis para edição. Além disso, campos personalizados criados dentro do sistema não podem ser integrados ou modificados.

  • POST /paciente/novo — Cria paciente. Body: PacienteForm.

  • GET /paciente/lista — Lista pacientes. Filtros: nomeContem, cpfCnpj, numeroIdentificacao, somenteAtivos, e por período de criação (dataInicial, dataFinal, dataPor=CRIACAO).

  • GET /paciente/{id} — Detalhe do paciente.

  • PUT /paciente/{id} — Altera paciente. Body: PacienteForm.

Origens e convênios do paciente

  • GET /origem/lista — Origens ativas de pacientes.

  • POST /origem/novo — Cria origem. Body: OrigemPacienteApiForm.

  • POST /convenio-paciente/associar — Associa convênio/plano a paciente. Body: AssociarConvenioPacienteForm.

  • GET /convenio-paciente/lista — Lista convênios de um paciente. Param: idPaciente (+ paginação e somenteAtivos).

  • GET /convenio-paciente/{id} — Detalhe de convênio/paciente por ID.

  • PUT /convenio-paciente/{id} — Altera dados do convênio/paciente. Body: PacienteConvenioAlteracaoForm.

Benefício (elegibilidade)

  • GET /plano-beneficio/elegibilidade — Verifica elegibilidade de cartão de benefício. Params: numeroCartao, tipoElegibilidade (MATRIZ/FILIAL).

Plano de tratamento odontológico

Nosso cliente pode visualizar o cadastro de planos de tratamento

  • GET /plano-tratamento/lista — Planos odontológicos de um paciente. Param obrigatório: idPaciente.

Profissional de saúde escola

Você poderá integrar alunos e professores (Profissionais da Saúde), e também configurar dados do cadastro do profissional

  • POST /clinica-escola/aluno/novo — Adiciona profissional aluno. Body: ProfissionalSaudeEscolaAlunoForm.

  • PUT /clinica-escola/aluno/{email} — Altera profissional aluno por e-mail. Body: ProfissionalSaudeEscolaAlunoAlteracaoForm.

  • POST /clinica-escola/supervisor/novo — Adiciona supervisor. Body: ProfissionalSaudeEscolaSupervisorForm.

  • PUT /clinica-escola/profissional/configurar/{email} — Configura profissional por e-mail. Body: ProfissionalSaudeConfiguracaoForm.

  • PUT /clinica-escola/profissional/ativar/{email} — Ativa profissional por e-mail.

  • PUT /clinica-escola/profissional/inativar/{email} — Inativa profissional por e-mail.

Para mais informações, acesse o site da nossa API Clínica nas Nuvens.

O que achou do nosso artigo? Deixe seu feedback! 💚


​

Artigos relacionados
Como adicionar clínicas?
Compartilhamento entre clínicas
Adicionando pacote de procedimentos
Configurações iniciais da sua clínica
Entenda os Indicadores de dados
Respondeu à sua pergunta?