Documentação / Referência da API

Referência da API

A API Medifontis é uma API REST somente leitura. Todos os endpoints são GET em um único host e retornam JSON.

URL base

https://api.medifontis.com/v1

Autenticação

Envie sua chave como Authorization: Bearer ou como X-Api-Key, nunca os dois. Autenticação.

Endpoints

O objeto de registro

country string
Código de duas letras do país da fonte.
sourceId string
A fonte de onde vem o registro, como it.aifa.packages.
id string
A identidade do registro dentro da fonte. Estável entre coletas.
kind string
O tipo de registro dentro da fonte, como packages, ingredients ou veterinary-medicines.
name string
O nome de exibição do registro: o primeiro de seus nomes.
names string[]
Todos os nomes pelos quais o registro pode ser encontrado, extraídos dos seus próprios campos.
identifiers object[]
Identificadores tipados no formato { scheme, value }, como aic, cn, ndc-package ou din. Os valores são sempre strings.
data object
Os campos normalizados da fonte, além de useDomain e targetSpecies com suas evidências.
region string | null
Uma região subnacional quando a fonte é regional; caso contrário, null.
retrievedAt string
Data e hora, em ISO 8601, em que o registro foi coletado da fonte.
sourceUrl string
O conjunto de dados oficial do qual o registro foi coletado.
licence object
A licença da fonte: id, url e o texto de atribuição a exibir.
limitations string[]
O que a fonte não comprova, como a comercialização atual ou a elegibilidade do paciente.

Erros

Os erros retornam um código de status e um corpo JSON com uma mensagem de erro. Erros e limites de requisições.

Versionamento

A versão faz parte do caminho. Novos campos e parâmetros opcionais podem surgir dentro da v1, então ignore os campos que você não conhece.

OpenAPI

O contrato completo é um documento OpenAPI 3.1 que você pode carregar em qualquer gerador de clientes ou ferramenta de API. /openapi.json