API de integração

Novo

Ligue o site, o CRM ou o chatbot da clínica à Medora para ler locais, profissionais, serviços e disponibilidades.

URL base: https://api.medora.pt/public/api/v1
Autenticação: Authorization: Bearer mk_live_…
Versão: v1 · só leitura

Visão geral

A API de integração dá aos sistemas da própria clínica acesso de leitura aos dados que a Medora usa para marcar consultas. Responde em JSON, autentica-se com uma chave da organização e expõe cinco recursos.

Recurso	Descrição
GET /locals	Locais da organização.
GET /professionals	Profissionais com horário configurado, opcionalmente num local.
GET /services	Serviços ativos, com duração e preço.
GET /appointment_types	Tipos de marcação ativos, com duração, atos e preço.
GET /availability	Horários marcáveis num intervalo de datas.

Ambiente	URL base
Produção	https://api.medora.pt/public/api/v1
Staging	https://api.staging.medora.pt/public/api/v1

Primeiro pedido

Crie uma chave (ver «Chaves de API»), guarde-a numa variável de ambiente e liste os locais da organização.

Pedido

export MEDORA_KEY="mk_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

curl -H "Authorization: Bearer $MEDORA_KEY" \
  https://api.medora.pt/public/api/v1/locals

Resposta 200

{
  "locals": [
    {
      "id": 12,
      "name": "Clínica São João",
      "slug": "clinica-sao-joao",
      "virtual": false,
      "public_booking_enabled": true,
      "public_booking_mode": "slots",
      "public_phone": "+351210000000",
      "public_email": "geral@clinica.pt",
      "public_address": "Rua Central 1, Porto",
      "public_website_url": "https://clinica.pt"
    }
  ]
}

A versão 1 é só de leitura. A marcação de consultas por API chega numa versão futura; até lá, marque na Medora ou através do widget de marcação.

Chaves de API

Cada chave pertence a uma organização e dá acesso de leitura a todos os seus locais. Só administradores da organização podem criar ou revogar chaves.

Abra Configurações › Organização › API.
Clique em «Nova chave» e dê-lhe o nome do sistema que a vai usar (por exemplo «Site da clínica» ou «CRM»).
Copie a chave mk_live_… nesse momento: por segurança não voltará a ser mostrada.
Para retirar o acesso a um sistema, revogue a chave. A revogação é imediata.

Guarde a chave em segurança. Trate-a como uma palavra-passe: não a partilhe, não a coloque em repositórios de código nem em ficheiros públicos, e mantenha-a numa variável de ambiente ou num cofre de segredos. Se suspeitar que foi exposta, revogue-a de imediato e crie outra.

Use uma chave por sistema. Assim pode revogar uma sem afetar as outras.
Pode chamar a API diretamente das páginas do site da clínica. Nesse caso a chave fica visível a quem visitar o site: use uma chave dedicada ao site e revogue-a se for abusada. A API só dá acesso de leitura a locais, profissionais, serviços, tipos de marcação e horários livres.
Uma organização pode ter até 20 chaves ativas em simultâneo.
Cada criação e revogação fica no registo de atividade da organização.

Autenticação

Envie a chave em todos os pedidos, no cabeçalho Authorization com o esquema Bearer.

Cabeçalho

Authorization: Bearer mk_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Situação	Estado	Código
Sem cabeçalho ou com outro formato	401	missing_api_key
Chave desconhecida ou revogada	401	invalid_api_key
Acesso da organização bloqueado (sem subscrição e fora dos períodos de só leitura)	403	organization_locked

Convenções

Tema	Regra
Formato	JSON em UTF-8. Apenas o método GET; outros métodos respondem 405 method_not_allowed.
Datas-hora	RFC 3339 com o fuso de Lisboa, por exemplo 2026-09-15T09:30:00+01:00. No horário de inverno o offset é escrito como Z (2026-12-15T09:30:00Z); compare instantes, não a string do offset.
Datas-dia	YYYY-MM-DD, interpretadas no fuso de Lisboa.
Identificadores	Os mesmos que vê na Medora: id do local, do profissional e do serviço (os serviços são os atos de Configurações › Agenda › Atos). Um identificador de outra organização responde como inexistente (404).
Versão	Todas as respostas trazem o cabeçalho X-Medora-Api-Version com a data do contrato (atualmente 2026-09-14). Só muda com uma alteração incompatível, que trará um novo prefixo /v2.
Cache	As respostas trazem Cache-Control: no-store. Se quiser guardar resultados, faça-o no seu sistema.

Limites de utilização

Cada chave pode fazer 120 pedidos por minuto, contados em conjunto por todos os sistemas que a usem. Acima disso a API responde 429 rate_limited com o cabeçalho Retry-After: 60.

Peça intervalos curtos de disponibilidade e guarde o resultado do seu lado durante alguns minutos.
Locais, profissionais e serviços mudam raramente; não precisa de os pedir em cada interação.
Ao receber 429, espere o tempo indicado em Retry-After antes de tentar de novo.

Locais

GET/localsLocais da organização.

Não tem parâmetros. Devolve todos os locais da organização, incluindo os que não aceitam marcação online.

Campos da resposta

Campo	Tipo	Descrição
id	inteiro	Identificador do local, usado em local_id noutros pedidos.
name	texto	Nome do local.
slug	texto	Identificador legível usado nos URLs públicos.
virtual	booleano	Verdadeiro para locais de teleconsulta, sem morada física.
public_booking_enabled	booleano	Se o local aceita marcações pelo portal e pelo widget.
public_booking_mode	texto	slots ou requests. Em requests (pedidos de marcação), o utente indica quando pode vir e a clínica escolhe a hora; o local não devolve horários em /availability.
public_phone	texto ou null	Telefone público.
public_email	texto ou null	Email público.
public_address	texto ou null	Morada pública.
public_website_url	texto ou null	Site do local.

Pedido

curl -H "Authorization: Bearer $MEDORA_KEY" \
  https://api.medora.pt/public/api/v1/locals

Resposta 200

{
  "locals": [
    {
      "id": 12,
      "name": "Clínica São João",
      "slug": "clinica-sao-joao",
      "virtual": false,
      "public_booking_enabled": true,
      "public_booking_mode": "slots",
      "public_phone": "+351210000000",
      "public_email": "geral@clinica.pt",
      "public_address": "Rua Central 1, Porto",
      "public_website_url": "https://clinica.pt"
    }
  ]
}

Profissionais

GET/professionalsProfissionais com horário configurado.

Parâmetros

Parâmetro	Obrigatório	Descrição
local_id	não	Limita aos profissionais com horário nesse local. Sem este parâmetro, devolve os de todos os locais da organização. Responde 404 se o local não pertencer à organização.

Campos da resposta

Campo	Tipo	Descrição
id	inteiro	Identificador do profissional, usado em provider_id nas disponibilidades.
name	texto	Nome.
title	texto ou null	Título (por exemplo «Dra.»).
display_name	texto	Título e nome, prontos a mostrar.
professional_title	texto ou null	Designação profissional (por exemplo «Médica Dentista»).
disciplines	lista de texto	Códigos estáveis das disciplinas que exerce (por exemplo psychology, dentistry).
licenses	lista	Cédulas profissionais: ordem (código), ordem_label (nome da ordem) e license_number.
local_ids	lista de inteiro	Locais onde tem horário.

Pedido

curl -H "Authorization: Bearer $MEDORA_KEY" \
  "https://api.medora.pt/public/api/v1/professionals?local_id=12"

Resposta 200

{
  "professionals": [
    {
      "id": 7,
      "name": "Ana Silva",
      "title": "Dra.",
      "display_name": "Dra. Ana Silva",
      "professional_title": "Médica Dentista",
      "disciplines": ["dentistry"],
      "licenses": [
        { "ordem": "omd", "ordem_label": "Ordem dos Médicos Dentistas", "license_number": "12345" }
      ],
      "local_ids": [12, 15]
    }
  ]
}

Serviços

GET/servicesServiços ativos, marcáveis online ou não.

Parâmetros

Parâmetro	Obrigatório	Descrição
local_id	não	Limita aos serviços desse local. Responde 404 se o local não pertencer à organização.

Campos da resposta

Campo	Tipo	Descrição
id	inteiro	Identificador do serviço, usado em service_id nas disponibilidades.
local_id	inteiro	Local a que o serviço pertence.
name	texto	Nome do serviço.
description	texto ou null	Descrição.
duration_minutes	inteiro	Duração de uma consulta deste serviço.
unit_price	número	Preço líquido, sem IVA.
iva_rate	texto	Taxa de IVA aplicada (por exemplo IVA6, IVA23, IVA0).
price	número	Preço bruto, o valor que o utente paga.
bookable_online	booleano	Indicador de marcação online do serviço. No portal e no widget, o que o utente escolhe são os tipos de marcação com «Marcação online» ligada. Serviços não marcáveis online continuam a poder ser lidos aqui.

Pedido

curl -H "Authorization: Bearer $MEDORA_KEY" \
  "https://api.medora.pt/public/api/v1/services?local_id=12"

Resposta 200

{
  "services": [
    {
      "id": 31,
      "local_id": 12,
      "name": "Consulta de avaliação",
      "description": null,
      "duration_minutes": 30,
      "unit_price": 40,
      "iva_rate": "IVA6",
      "price": 42.4,
      "bookable_online": true
    }
  ]
}

Tipos de marcação

GET/appointment_typesTipos de marcação ativos, marcáveis online ou não.

Um tipo de marcação é o que o utente marca (por exemplo «Sessão de fisioterapia»): define a duração e reúne um ou mais atos. É o que a página pública e o widget mostram ao utente. Use o id em appointment_type_id nas disponibilidades.

Parâmetros

Parâmetro	Obrigatório	Descrição
local_id	não	Limita aos tipos desse local. Responde 404 se o local não pertencer à organização.

Campos da resposta

Campo	Tipo	Descrição
id	inteiro	Identificador do tipo, usado em appointment_type_id nas disponibilidades.
local_id	inteiro	Local a que o tipo pertence.
name	texto	Nome do tipo de marcação.
description	texto ou null	Descrição.
duration_minutes	inteiro	Duração de uma consulta deste tipo.
discipline	texto ou null	Código da especialidade (por exemplo physiotherapy), se definida.
bookable_online	booleano	Se aparece na página pública, no widget e no portal.
price	número	Preço bruto para um utente particular: a soma dos atos.
acts	lista	Atos incluídos: service_id, name, quantity e price (bruto, já multiplicado pela quantidade).

Pedido

curl -H "Authorization: Bearer $MEDORA_KEY" \
  "https://api.medora.pt/public/api/v1/appointment_types?local_id=12"

Resposta 200

{
  "appointment_types": [
    {
      "id": 5,
      "local_id": 12,
      "name": "Sessão de fisioterapia",
      "description": null,
      "duration_minutes": 45,
      "discipline": "physiotherapy",
      "bookable_online": true,
      "price": 42.4,
      "acts": [
        { "service_id": 31, "name": "Consulta de avaliação", "quantity": 1, "price": 42.4 }
      ]
    }
  ]
}

Disponibilidades

GET/availabilityHorários marcáveis num intervalo de datas.

Devolve os horários em que é possível marcar, já com a duração, os horários de trabalho, os bloqueios, as ausências, as consultas existentes e o limite de sobreposição aplicados. Usa o mesmo motor do widget de marcação.

Parâmetros

Parâmetro	Predefinição	Descrição
from	hoje	Primeiro dia, YYYY-MM-DD, inclusive.
to	from + 7 dias	Último dia, inclusive. Tem de ser igual ou posterior a from e no máximo 31 dias depois.
local_id	todos	Limita a um local. Responde 404 se não pertencer à organização.
provider_id	todos	Limita a um profissional. Repetível (provider_id=7&provider_id=9); identificadores desconhecidos são ignorados.
service_id	—	Serviço a marcar. Define a duração (a do tipo de marcação associado ao serviço, quando existe; caso contrário, a do próprio serviço) e restringe ao local do serviço. Responde 404 se não existir, estiver inativo ou pertencer a outro local que não o local_id pedido.
appointment_type_id	—	Tipo de marcação a marcar (ver «Tipos de marcação»). Define a duração e restringe ao local do tipo; tem prioridade sobre service_id. Responde 404 se não existir, estiver arquivado ou pertencer a outro local que não o local_id pedido.
duration_minutes	30	Duração em minutos, de 5 a 480. Ignorado quando há service_id ou appointment_type_id.

Campos da resposta

Campo	Tipo	Descrição
from, to	data	Intervalo efetivamente calculado.
timezone	texto	Sempre Europe/Lisbon.
duration_minutes	inteiro	Duração usada para calcular os horários.
service_id	inteiro ou null	Serviço pedido, se houver.
appointment_type_id	inteiro ou null	Tipo de marcação usado para a duração, se houver.
slots	lista	Horários marcáveis, ordenados por início: local_id, provider_id, start e end.
professionals	lista	Profissionais considerados: id e display_name.
locals	lista	Locais considerados: id, name e public_booking_mode.

Pedido

curl -H "Authorization: Bearer $MEDORA_KEY" \
  "https://api.medora.pt/public/api/v1/availability?service_id=31&from=2026-09-15&to=2026-09-22"

Resposta 200

{
  "from": "2026-09-15",
  "to": "2026-09-22",
  "timezone": "Europe/Lisbon",
  "duration_minutes": 30,
  "service_id": 31,
  "slots": [
    { "local_id": 12, "provider_id": 7, "start": "2026-09-15T09:00:00+01:00", "end": "2026-09-15T09:30:00+01:00" },
    { "local_id": 12, "provider_id": 7, "start": "2026-09-15T09:15:00+01:00", "end": "2026-09-15T09:45:00+01:00" }
  ],
  "professionals": [{ "id": 7, "display_name": "Dra. Ana Silva" }],
  "locals": [{ "id": 12, "name": "Clínica São João", "public_booking_mode": "slots" }]
}

Os horários começam de 15 em 15 minutos, ou no intervalo definido nas regras de agendamento do local, e sobrepõem-se; escolha um.
Horários já iniciados nunca são devolvidos e dias anteriores a hoje não são calculados.
Não há antecedência mínima: a clínica decide as suas regras.
Sem service_id nem appointment_type_id, a duração vem de duration_minutes e não é considerado nenhum serviço.
Locais em modo requests não devolvem horários; continuam em locals com public_booking_mode.

Erros

Os erros têm sempre a mesma forma. O código é estável e serve para o seu sistema decidir; a mensagem é para pessoas e pode mudar. O campo param só aparece em invalid_parameter e indica o parâmetro inválido.

Resposta 422

{
  "error": {
    "code": "invalid_parameter",
    "message": "O parâmetro from tem de ser uma data YYYY-MM-DD",
    "param": "from"
  }
}

Estado	Código	Quando acontece
401	missing_api_key	Falta o cabeçalho Authorization ou tem outro formato.
401	invalid_api_key	Chave desconhecida ou revogada.
403	organization_locked	O acesso da organização está bloqueado: não tem subscrição ativa nem está num período de só leitura.
404	not_found	Rota inexistente, ou local, profissional, serviço ou tipo de marcação que não existe nesta organização.
405	method_not_allowed	Método diferente de GET.
422	invalid_parameter	Parâmetro com formato ou valor inválido; param indica qual.
422	invalid_range	to anterior a from, ou intervalo superior a 31 dias.
429	rate_limited	Mais de 120 pedidos num minuto; volte a tentar após Retry-After.
500	internal_error	Erro do lado da Medora. Tente de novo mais tarde; se persistir, contacte o apoio.