Saltar para o conteúdo principal
Um local é um centro de análises físico onde profissionais de saúde realizam colheitas de sangue. Usas o id de um local para agendar marcações practitioner.
A tua chave API só devolve locais dentro do teu contexto de acesso de parceiro. Usa GET /api/v1/locations para listar todos os locais disponíveis para ti.
Um webhook location.* avisa-te quando um local aparece, muda ou desaparece.

Campos

string
obrigatório
UUID do local. Passa-o como location_id ao criar uma marcação.
string
obrigatório
Nome de apresentação do local.
string
Clínica ou empresa que opera o local. Pode ser null.
string
Nome da rua, sem o número de porta. Pode ser null.
string
Número de porta. Pode ser null.
string
Linha de morada adicional — a/c, edifício ou andar. Pode ser null.
string
Cidade. Pode ser null.
string
Estado ou província (resolvido através do estado associado à cidade). Pode ser null quando a cidade não tem estado associado.
string
Código ISO 3166-2 do estado sem o prefixo do país (por ex., BW para Baden-Württemberg). Pode ser nulo.
string
Código postal ou ZIP. Pode ser nulo.
string
Nome completo do país (por ex., Germany). Pode ser nulo.
string
Código de país de duas letras segundo ISO 3166-1 alpha-2 (por ex., DE, US). Pode ser nulo.
string
Identificador de fuso horário IANA do local (por ex., Europe/Berlin, America/New_York). Usa-o para mostrar os horários marcados na hora local correta. Pode ser nulo.
number
Latitude da morada em graus decimais (WGS 84). Pode ser nulo.
number
Longitude da morada em graus decimais (WGS 84). Pode ser nulo.
string
Número de telefone do local. Pode ser nulo.
string
Endereço de email do local. Pode ser nulo.
string
URL do site do local. Pode ser nulo.
string
Ligação direta para o local no Google Maps. Pode ser nulo.
string
URL de uma fotografia do local. Pode ser nulo.
object
Horário de funcionamento semanal do local. Cada chave de dia da semana (monday–sunday) corresponde a um array de intervalos horários { open, close } no formato HH:MM (24h). Um array vazio significa que o local está fechado nesse dia. Pode ser nulo se o horário não estiver disponível para o local.
string
obrigatório
Como o sangue é colhido numa marcação neste local, a menos que a marcação defina o seu próprio draw_method: capillary (ponta do dedo ou parte superior do braço, para microtubos) ou venous (da veia, para tubos).
string[]
obrigatório
Os métodos de colheita para os quais o local tem recipientes em stock, ordenados. Uma marcação neste local só pode definir um destes como o seu draw_method.
Usa sempre o campo timezone para converter as datas e horas de scheduled_at para a hora local antes de as mostrar aos pacientes ou à equipa.

Disponibilidade

O campo open_hours acima descreve o horário de funcionamento semanal estático. Para mostrar horários reais disponíveis para marcação — e evitar marcações duplicadas com marcações Aniva já existentes — chama Obter disponibilidade para o local e passa o intervalo de datas que queres mostrar. Esse endpoint é a fonte de verdade certa para qualquer interface de marcação: expande open_hours na grelha de horários do local, aplica exceções por data, subtrai as marcações já feitas e aplica a antecedência mínima.

Preços de retalho

Uma farmácia define o seu próprio preço para cada painel, e para cada biomarcador individual, que vende a clientes sem marcação. Só vês um preço depois de a farmácia o publicar. Listar preços de retalho devolve-os para cada local que podes ler, e Obter preços de retalho devolve-os para um local. Ambos precisam do scope retail_prices_view; locations_view não os inclui. Pede ambos os scopes para os mesmos locais. Um webhook location.retail_prices.updated avisa-te quando um preço muda. location.created e location.deactivated avisam-te quando um local aparece ou desaparece. Uma alteração aos painéis que um local oferece pode chegar-te mais tarde do que uma alteração de preço, por isso lê Listar preços de retalho novamente uma vez por dia.

Exemplo de local