API Pública Sivoe — Portal de Integração

Visão geral

A API Pública Sivoe expõe endpoints REST para sistemas parceiros consultarem e movimentarem dados de pacientes, exames, laudos e agenda das clínicas integradas. A autenticação é feita via HMAC-SHA256 com janela anti-replay de 5 minutos.

Quer integrar? Solicite suas credenciais ao suporte Sivoe em contato@roomtec.com.br. Para experimentar imediatamente, use a chave sandbox pública abaixo — sem cadastro.

Ambientes

Ambiente	Base URL	Como obter credenciais
Sandbox	`https://api.sivoe.med.br`	Chave pública publicada no Sandbox — dados sintéticos, escopos `:read`.
Produção	`https://api.sivoe.med.br`	Solicite à Sivoe em contato@roomtec.com.br.

Sandbox e produção compartilham a mesma URL — o ambiente é determinado pela chave apresentada. Para entender a fórmula HMAC, abra o guia de autenticação.

O que está disponível na v1 (release 1.1.0)

disponível 31 endpoints REST cobrindo pacientes (leitura + escrita), exames (leitura + escrita), laudos (leitura + ingestão), prontuários do paciente (leitura + escrita), agenda, catálogos (procedimentos, convênios, médicos, CIDs) e a configuração da chave (GET /v1/config) — veja o resumo ou a referência detalhada PT-BR.
disponível Leitura completa (GET) de pacientes, exames, laudos e agenda + 3 operações de escrita de agenda (POST) + 3 operações de escrita de paciente (POST + PATCH + POST /v1/pacientes/unificar para unificar duplicados, Fase 3* em piloto desde 2026-05-20) + criação de exame (POST /v1/exames) + ingestão de laudo assinado (POST /v1/exames/{id}/laudo, Fase 6) com Idempotency-Key obrigatório.
disponível Prontuários do paciente (mensagem HTML e/ou anexos) via POST /v1/pacientes/{id}/prontuarios + leitura de mensagens e metadados de anexos — Fase 7. A listagem de anexos nunca expõe URL/chave S3; o download é via endpoint dedicado (presigned 302).
disponível PDFs de exames e laudos via redirect 302 para presigned S3 (validade 300s).
disponível Try it out interativo (Swagger UI abaixo) — HMAC calculado no navegador via Web Crypto API.
disponível Guia de autenticação HMAC + receitas em Bash · Python · Node.js · PHP.
disponível Catálogo de erros + FAQ + Sandbox + Console HMAC (debug lado a lado).
disponível Criação de exame (POST /v1/exames) com upload de arquivos inline em base64 — Fase 6.
disponível Catálogos (GET) — /v1/procedimentos, /v1/convenios (com planos aninhados), /v1/medicos (filtro por papel) e /v1/cids (busca CID-10) — base para preencher os *_id nas escritas. Cacheáveis (private, max-age=300).
disponível Aliases de negócio no POST /v1/exames (release 1.1.0) — em vez dos *_id, envie identificadores legíveis (paciente_cpf, procedimento_codigo_tuss/procedimento_abreviacao, convenio_codigo_ans/convenio_nome, medico_exame_crm/medico_laudo_crm, unidade_nome) e o gateway resolve para o id interno. Conflito entre *_id e alias devolve 422 acionável.
disponível Defaults por clínica (release 1.1.0) — unidade_id, medico_exame_id, medico_laudo_id e convenio_id podem ser omitidos no POST /v1/exames quando a clínica tem default configurado. Consulte o GET /v1/config para descobrir o que pode ser omitido.
disponível Configuração da chave (GET /v1/config, release 1.1.0) — devolve version, api_version, os escopos da chave e os defaults do tenant. Cacheável (private, max-age=300).
em breve SDKs oficiais em Node.js, Python e Go.

Documentação da API

⚠ Ambiente Sandbox — para testar agora, use a chave pública abaixo no botão Authorize. Nunca cole uma chave de produção em um navegador. api_key: svp_live_77790ba9682bf8b515072a786111b491
api_secret: solicite ao suporte em contato@roomtec.com.br (ou veja o Sandbox) O HMAC-SHA256 é calculado no seu navegador via Web Crypto API — o api_secret nunca sai da sua máquina (descartado antes do envio HTTP).

A spec OpenAPI 3.1 (release 1.1.0) cobre as 30 operações da v1 (pacientes — leitura + escrita, exames — leitura + escrita, laudos — leitura + ingestão, prontuários do paciente — leitura + escrita (Fase 7), agenda, catálogos — procedimentos, convênios, médicos e CIDs — e a configuração da chave GET /v1/config — incluindo os 3 POSTs de agenda, os POST/PATCH /v1/pacientes da Fase 3*, o POST /v1/exames (com aliases de negócio e defaults por clínica na release 1.1.0) e a ingestão de laudo assinado POST /v1/exames/{id}/laudo da Fase 6, todos com Idempotency-Key). Try it out habilitado para todas as operações GET, para os POST de agenda, para POST/PATCH de paciente, para o POST de exame e para a ingestão de laudo assinado.