Saltar para o conteúdo principal
Usa este guia para encontrar um local de teste, criar uma marcação para um perfil de paciente e associar os painéis de análise a realizar. Conclui estes passos antes de o paciente chegar para a colheita de sangue.
1

Explorar locais disponíveis

Obtém a lista de locais de teste disponíveis na tua conta enviando um pedido GET para /api/v1/locations.
A resposta é um array de objetos de local:
Usa o campo timezone do objeto de local ao construir o timestamp de scheduled_at. Converter a hora da marcação para o fuso horário do local ajuda-te a evitar agendar fora do horário de funcionamento.
Não deduzas horários disponíveis apenas a partir de open_hours. Chama Obter disponibilidade e agenda uma das horas de início devolvidas — essa grelha também tem em conta marcações existentes, exceções por data e a antecedência mínima.
2

Criar a marcação

Envia um pedido POST para /api/v1/appointments com o ID do perfil, o ID do local e a hora pretendida para a marcação. A hora tem de corresponder a uma hora de início devolvida por Obter disponibilidade.
scheduled_at tem de ser uma data e hora futura no formato ISO 8601, por exemplo 2026-05-12T07:30:00Z. Timestamps no passado são rejeitados com um erro 400, assim como horários dentro da antecedência mínima de 12 horas em locais geridos pela Aniva.
Repetir este pedido é seguro. Um perfil só pode ter uma marcação por local e hora, pelo que um pedido de criação reenviado ou duplicado devolve 409 com o appointment_id existente em vez de criar duas marcações para o paciente.
Um pedido bem-sucedido devolve 201 Created com o objeto da marcação:
Guarda o id da marcação — vais precisar dele para adicionar painéis e confirmar a colheita de sangue.
3

Adicionar painéis de análise

Associa os painéis de análise que queres realizar na amostra de sangue enviando um pedido POST para /api/v1/appointments/{id}/panels.Os IDs dos painéis são UUIDs. Chama Listar painéis para obter os painéis que a tua chave API pode pedir.
Não é possível adicionar painéis depois de a colheita de sangue ser confirmada. Adiciona todos os painéis necessários antes da confirmação — consulta Confirmar colheita de sangue para mais detalhes.
Um pedido bem-sucedido devolve 200 OK, confirmando que os painéis foram adicionados:

Reagendar ou cancelar

Depois de criares uma marcação, ainda a podes modificar antes de a colheita de sangue ser confirmada:
  • Reagendar ou alterar o local — Envia um pedido PATCH para /api/v1/appointments/{id} com os campos a atualizar. Consulta Atualizar marcação.
  • Cancelar — Envia um pedido DELETE para /api/v1/appointments/{id}. Consulta Cancelar marcação.
Ambas as operações só estão disponíveis antes da colheita de sangue — ou seja, enquanto a marcação estiver no estado pending ou confirmed. Assim que a marcação passar para blood_drawn, não são possíveis mais modificações.

Tratamento de erros