> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> Visão geral da API de parceiros da Aniva, uma API REST para análises ao sangue em farmácias e clínicas, kits de teste em casa e resultados laboratoriais.

A Aniva Partner API é uma API REST que permite aos parceiros de saúde gerir perfis de pacientes, agendar marcações de colheita de sangue em locais de análise e acionar pipelines de pedidos laboratoriais. Interages com a API por HTTPS com a tua chave de API de parceiro.

## O que podes fazer

* **Gestão de perfis** — Cria, obtém e atualiza perfis demográficos de pacientes.
* **Agendamento de marcações** — Agenda marcações de colheita de sangue em locais de análise da Aniva.
* **Gestão de painéis** — Adiciona ou remove painéis de análises laboratoriais numa marcação existente.
* **Biomarcadores individuais** — Associa ou desassocia biomarcadores individuais numa marcação sem escolher um painel.
* **Pedidos de kits de teste em casa** — Envia um kit de teste em casa por correio a um paciente, acompanha as respetivas encomendas e comunica quando a amostra foi colhida.
* **Catálogo de painéis** — Explora os painéis disponíveis com `GET /api/v1/panels` para descobrir os IDs dos painéis e os biomarcadores incluídos.
* **Catálogo de biomarcadores** — Explora os biomarcadores que podes pedir num local de análise ou num kit de teste em casa com `GET /api/v1/biomarkers` para descobrir os IDs.
* **Confirmação de colheita de sangue** — Submete o(s) código(s) de laboratório após uma colheita para acionar o pipeline de pedidos laboratoriais.
* **Resultados laboratoriais** — Obtém resultados clínicos e genéticos e transfere os PDFs dos relatórios laboratoriais.
* **Descoberta de locais** — Lista os locais de análise disponíveis para apresentar aos pacientes.
* **Logística de envios** — Cria, acompanha, modifica e cancela pedidos de envio por transportadora.
* **Webhooks** — Recebe uma chamada HTTPS quando uma marcação, um pedido de kit de teste em casa, os respetivos resultados, um local, um perfil ou um envio muda. Consulta [Webhooks](https://docs.anivahealth.com/pt/concepts/webhooks.md).

## Explora a documentação

> [card] [Autenticação](https://docs.anivahealth.com/pt/authentication.md)
>
> Autentica pedidos com a tua chave de API de parceiro.

> [card] [Início rápido](https://docs.anivahealth.com/pt/quickstart.md)
>
> Faz a tua primeira chamada à API em minutos com exemplos passo a passo.

> [card] [Perfis](https://docs.anivahealth.com/pt/concepts/profiles.md)
>
> Aprende como funcionam os perfis de pacientes e que dados guardam.

> [card] [Marcações](https://docs.anivahealth.com/pt/concepts/appointments.md)
>
> Compreende o ciclo de vida de uma marcação, do agendamento à confirmação.

> [card] [Pedidos de kits de teste em casa](https://docs.anivahealth.com/pt/concepts/home-kit-orders.md)
>
> Envia um kit de teste para casa de um paciente e acompanha-o até a amostra chegar ao laboratório.

## Versões da API

A versão atual da API é **v1**. Todos os endpoints têm o prefixo `/api/v1/`. O URL base é `https://anivahealth.com`.

```text theme={null}
https://anivahealth.com/api/v1/
```

Alterações incompatíveis serão introduzidas sob um novo prefixo de versão. A API v1 permanecerá disponível, com aviso prévio sobre qualquer descontinuação.

## Datas e fusos horários

Todos os instantes transmitidos estão em **UTC ISO 8601** (sufixo `Z`). Os campos apenas de calendário usam **componentes de relógio
local** (`YYYY-MM-DD`, `HH:MM`).

| Categoria | Formato | Usado em |
| - | - | - |
| **Instante** | ISO 8601 em UTC (sufixo `Z`, p. ex. `2026-04-15T08:30:00Z`) | Todas as datas e horas na resposta — `scheduled_at` da marcação, `slots[]` de disponibilidade, `pickup.from` / `pickup.till` do envio, `created_at`, `updated_at`, `added_at`. Apresenta em qualquer fuso horário local no cliente. |
| **Evento do fornecedor** | ISO 8601 com o desvio do fornecedor de origem (transmitido tal qual) | Apenas `status_updates[].time` do envio — o desvio reflete o que a transportadora comunicou. |
| **Relógio local** | `YYYY-MM-DD` para datas, `HH:MM` para horas — sem desvio | Valores apenas de calendário ou hora do dia — `date_of_birth`, `tested_at` dos resultados, `start_date` / `end_date` de disponibilidade, `pickup_date` / `pickup_time_from` / `pickup_time_till` do envio, `open_hours` do local. |

Notas específicas:

* **Entradas que aceitam data e hora** (p. ex. `scheduled_at` em `POST` / `PATCH /api/v1/appointments`)
  **têm de incluir um designador de fuso horário** — seja `Z` ou um desvio explícito como `+02:00`. Datas e horas
  sem fuso horário são rejeitadas com `400`. Ambas as formas codificam o mesmo instante; a resposta devolve
  sempre `scheduled_at` em UTC `Z`. Usa o campo `timezone` do local (ou qualquer outro identificador
  IANA) para formatar o instante na hora local ao apresentá-lo.
* **Entradas de relógio local** são interpretadas no fuso horário do recurso a que se destinam: as datas de
  disponibilidade usam o parâmetro de consulta `timezone` (por predefinição, o fuso horário do local); `pickup_date` / `pickup_time_*`
  do envio são interpretados no fuso horário do local de origem.
* **Campos de resposta apenas de data** (p. ex. `tested_at`, `availability[].date` de disponibilidade) são
  datas de calendário sem fuso horário.

## Obter acesso

As chaves de API são emitidas por parceiro pela Aniva.

> [!NOTE]
>
> Contacta a Aniva para receberes a tua chave de API de parceiro.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.