Referencia da API da plataforma
A API REST da vitalera expoe 148 endpoints em mais de 20 grupos de recursos, cobrindo tudo desde a ingestao de sinais vitais ate a gestao do ciclo de vida dos planos de cuidados. Todos os endpoints retornam JSON e seguem convencoes RESTful com modelos de dados alinhados com FHIR R5.
Documentacao completa da API
A referencia interativa da API com esquemas de pedido/resposta, detalhes de parametros e exemplos de payloads esta disponivel para clientes no dashboard vitalera. Contacte info@vitalera.io para acesso.
Autenticacao e utilizadores
| Grupo | Endpoints | Descricao |
|---|---|---|
| Autenticacao JWT | 4 | Gerar, atualizar, validar e desativar tokens JWT |
| Autenticacao de integracao | 1 | Redirecionamento SSO para fornecedores de identidade externos |
| Gestao de credenciais | 1 | Rotacao de credenciais de cliente da aplicacao |
| Utilizadores e permissoes | 1 | Permissoes e informacoes de funcao do utilizador atual |
Participantes
| Grupo | Endpoints | Descricao |
|---|---|---|
| Monitorizados (Pacientes) | 10 | Criar, listar, atualizar, eliminar participantes. Exportar listas, obter resumos, gerir atribuicoes de cuidados e consultar planos predefinidos. |
| Profissionais | 5 | Criar, listar, atualizar, eliminar profissionais de saude e membros da equipa de cuidados. |
| Equipas de monitorizacao | 1 | Listar membros da equipa de monitorizacao por definicao de plano. |
| Resumos | 1 | Contadores agregados de participantes monitorizados. |
Planos de cuidados e tarefas
| Grupo | Endpoints | Descricao |
|---|---|---|
| Definicoes de plano | 11 | Gerir modelos de plano -- listar, obter, publicar, retirar, rever. Consultar acoes, configuracoes de app, organizacoes, campos de perfil e estado de validacao. |
| Planos de monitorizados | 26 | Gestao completa do ciclo de vida -- criar, ativar, suspender, retomar, completar, revogar. Gerir membros da equipa de monitorizacao, sobreposicoes, triggers, desvios, campos personalizados e gerar relatorios PDF. |
| Tarefas | 10 | Gerir tarefas clinicas e de bem-estar -- listar, aceitar, iniciar, completar, cancelar, falhar, rejeitar. Contadores de tarefas pendentes para badges de dashboard. |
Observations -- Sinais vitais
| Grupo | Endpoints | Descricao |
|---|---|---|
| Pressao arterial | 2 | Sistolica, diastolica e pressao arterial media |
| Frequencia cardiaca | 2 | Medicoes continuas e pontuais de frequencia cardiaca |
| Saturacao de oxigenio (SpO2) | 2 | Leituras de oximetria de pulso |
| Temperatura | 2 | Medicoes de temperatura corporal |
| Colesterol | 2 | Paineis de colesterol total, LDL, HDL |
Observations -- Atividade e fitness
| Grupo | Endpoints | Descricao |
|---|---|---|
| Contagem de passos | 2 | Dados de passos diarios e intradiarios |
| Calorias | 2 | Gasto calorico ativo e total |
| Distancia | 2 | Distancia percorrida (caminhada, corrida, ciclismo) |
| Andares subidos | 2 | Ganho de elevacao e andares |
| Minutos ativos | 2 | Minutos ativos diarios por zona de intensidade |
| Treinos | 2 | Sessoes de treino estruturadas com voltas, zonas de FC, ritmo |
| VO2 Max | 2 | Consumo maximo estimado de oxigenio |
Observations -- Sono e recuperacao
| Grupo | Endpoints | Descricao |
|---|---|---|
| Sessoes de sono | 3 | Duracao do sono, eficiencia e metadados da sessao |
| Fases do sono | 2 | Detalhes das fases leve, profundo, REM e acordado |
| Respiracao durante o sono | 2 | Frequencia respiratoria e perturbacoes durante o sono |
| Indice de stress | 2 | Niveis de stress diarios e tendencias |
| Indice de recuperacao | 2 | Prontidao de recuperacao pos-exercicio |
| Indice de esforco | 2 | Esforco cardiovascular da atividade |
| Nivel de energia | 2 | Niveis de Body Battery / reserva de energia |
Observations -- Especializados
| Grupo | Endpoints | Descricao |
|---|---|---|
| Glicemia | 2 | Leituras pontuais de glicemia |
| Leituras CGM | 2 | Pontos de dados de monitorizacao continua de glicemia |
| Resumos CGM | 2 | Tempo no intervalo, glicemia media, variabilidade |
| Alertas CGM | 2 | Eventos de alerta de glicemia alta/baixa |
| HRV | 2 | Variabilidade da frequencia cardiaca (RMSSD, SDNN) |
| ECG | 2 | Dados de forma de onda de eletrocardiograma |
| Composicao corporal | 2 | Peso, percentagem de gordura corporal, massa muscular, IMC |
| Temperatura cutanea | 2 | Leituras continuas de temperatura cutanea |
| Pico de fluxo expirat. | 2 | Monitorizacao de asma e DPOC |
| Frequencia respiratoria | 2 | Medicoes de frequencia respiratoria |
| Espirometria | 2 | FEV1, FVC e outras metricas de funcao pulmonar |
| Saude mental | 4 | Rastreio de estado de humor e pontuacoes de avaliacao |
Observations -- Geral
| Grupo | Endpoints | Descricao |
|---|---|---|
| Qualidade dos dados | 1 | Metricas de qualidade para fluxos de dados de observacao |
| Upload de ficheiro FIT | 1 | Upload de ficheiros FIT brutos Garmin para processamento |
| Garmin Sleep | 1 | Ingestao direta de dados da API Garmin Sleep |
| Garmin Gaps | 1 | Identificar lacunas nos fluxos de dados Garmin |
Questionarios
| Grupo | Endpoints | Descricao |
|---|---|---|
| Questionarios | 4 | Listar questionarios, obter detalhes, obter itens com traducoes (Accept-Language) e consultar respostas. |
Alarmes
| Grupo | Endpoints | Descricao |
|---|---|---|
| Problemas detetados | 7 | Classificar, cancelar ou marcar alarmes como erro de registo. Atualizar detalhes de classificacao. Consultar alarmes acionados. |
Consultas
| Grupo | Endpoints | Descricao |
|---|---|---|
| Consultas | 6 | Ciclo de vida completo de agendamento -- reservar, check-in, concretizar, cancelar, nao comparencia, marcar erro. |
Integracoes de dispositivos
| Grupo | Endpoints | Descricao |
|---|---|---|
| Fitbit | 4 | Vincular/desvincular contas Fitbit, verificar estado da vinculacao, consultar ultima sincronizacao. |
| Garmin | 1 | Endpoints de ingestao direta de dados Garmin. |
Conteudo
| Grupo | Endpoints | Descricao |
|---|---|---|
| Biblioteca | 1 | Listar recursos de conteudo educacional e informativo. |
URL base
https://api.vitalera.io/api/
Autenticacao
Todos os endpoints requerem um token JWT Bearer valido. Consulte Autenticacao da API da plataforma.
Padroes comuns
- Paginacao -- Os endpoints de lista retornam resultados paginados com os campos
count,nexteprevious. - Filtragem -- A maioria dos endpoints de lista suporta parametros de consulta para filtragem por estado, data e campos especificos do recurso.
- Traducoes -- Os recursos com conteudo traduzivel suportam o cabecalho
Accept-Language. - Transicoes de estado -- Os recursos com ciclos de vida (tarefas, planos, consultas, alarmes) utilizam endpoints dedicados
POST /{id}/{action}/. - Limites de taxa -- Consulte Limites de taxa e quotas.
Obter acesso completo
A referencia interativa da API com esquemas completos de pedido/resposta, documentacao de parametros e um ambiente sandbox esta disponivel para clientes. Contacte-nos para credenciais.