Sandbox — API Pública Sivoe

Para experimentar a API antes do onboarding, use a chave sandbox abaixo. Ela aponta para uma clínica dedicada (sandbox) com dados sintéticos, escopos :read apenas e sem SLA.

Chave pública sandbox

api_key svp_live_77790ba9682bf8b515072a786111b491

api_secret solicite ao suporte Sivoe em contato@roomtec.com.br — é entregue por canal seguro e exibido uma única vez.

⚠ Nunca cole uma chave de produção em um navegador. A Web Crypto API garante que o secret não saia do seu computador quando você usa o Try it out ou o Console HMAC, mas isto só vale para a chave sandbox pública — chaves reais devem viver em servidor / vault.

cURL pronto para copiar

1) Health check — `GET /v1/ping`

API_KEY="svp_live_77790ba9682bf8b515072a786111b491"
API_SECRET="<seu api_secret recebido por canal seguro>"
BASE="https://api.sivoe.med.br"
TS=$(date +%s)
PATH_Q="/v1/ping"
PAYLOAD="${TS}.GET ${PATH_Q}
"
SIG=$(printf '%s' "$PAYLOAD" | openssl dgst -sha256 -hmac "$API_SECRET" | awk '{print $2}')

curl -i \
  -H "X-API-Key: $API_KEY" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG" \
  "$BASE$PATH_Q"

2) Listar pacientes — `GET /v1/pacientes?limit=5`

API_KEY="svp_live_77790ba9682bf8b515072a786111b491"
API_SECRET="<seu api_secret recebido por canal seguro>"
BASE="https://api.sivoe.med.br"
TS=$(date +%s)
PATH_Q="/v1/pacientes?limit=5"
PAYLOAD="${TS}.GET ${PATH_Q}
"
SIG=$(printf '%s' "$PAYLOAD" | openssl dgst -sha256 -hmac "$API_SECRET" | awk '{print $2}')

curl -s \
  -H "X-API-Key: $API_KEY" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG" \
  "$BASE$PATH_Q" | jq .

3) Listar exames assinados — `GET /v1/exames?status_laudo=ASSINADO&limit=5`

API_KEY="svp_live_77790ba9682bf8b515072a786111b491"
API_SECRET="<seu api_secret recebido por canal seguro>"
BASE="https://api.sivoe.med.br"
TS=$(date +%s)
PATH_Q="/v1/exames?status_laudo=ASSINADO&limit=5"
PAYLOAD="${TS}.GET ${PATH_Q}
"
SIG=$(printf '%s' "$PAYLOAD" | openssl dgst -sha256 -hmac "$API_SECRET" | awk '{print $2}')

curl -s \
  -H "X-API-Key: $API_KEY" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG" \
  "$BASE$PATH_Q" | jq .

Receitas equivalentes em Python, Node.js e PHP nos guias HMAC.

Limitações do ambiente sandbox

Leitura + escrita de agenda. Estão habilitados todos os GET, o POST /v1/ping e os 3 POST de agenda. Endpoints de escrita de paciente / exame / laudo serão liberados em release futura.
Dados sintéticos. Pacientes / exames / laudos são fictícios. Não confundir com produção.
Sem SLA. Ambiente de demonstração — pode ficar indisponível para manutenção sem aviso.
Reset eventual. Os dados sintéticos podem ser reconstruídos a qualquer momento — não persista IDs.
Rate limit. Receberá 429 ao exceder a cota — reduza concorrência e use backoff.
Cold call. A 1ª chamada após inatividade leva ~2,3s (cache de autenticação interna). Subsequentes em <800ms.

Próximos passos

Abrir o Swagger UI e clicar em Authorize → colar api_key + api_secret → testar qualquer endpoint via Try it out.
Usar o Console HMAC quando uma assinatura está sendo recusada e você quer ver request · payload assinado · resposta lado a lado.
Ler o guia de autenticação para entender a fórmula do payload e a janela ±300s.
Consultar o catálogo de erros quando bater em AUTH_*, VAL_* ou BACKEND_*.
Quando estiver pronto para integrar em produção, solicite suas credenciais à Sivoe em contato@roomtec.com.br.