Documentation / Référence de l’API

Référence de l’API

L’API Medifontis est une API REST en lecture seule. Chaque endpoint est un GET servi par un seul hôte, qui renvoie du JSON.

URL de base

https://api.medifontis.com/v1

Authentification

Envoyez votre clé via Authorization: Bearer ou via X-Api-Key, jamais les deux. Authentification.

Endpoints

L’objet Record

country string
Code pays à deux lettres de la source.
sourceId string
La source dont provient la fiche, par exemple it.aifa.packages.
id string
L’identité de la fiche au sein de sa source. Stable d’une collecte à l’autre.
kind string
Le type de fiche au sein de la source, comme packages, ingredients ou veterinary-medicines.
name string
Le nom d’affichage de la fiche : son premier nom.
names string[]
Tous les noms sous lesquels la fiche peut être trouvée, issus de ses propres champs.
identifiers object[]
Identifiants typés sous la forme { scheme, value }, comme aic, cn, ndc-package ou din. Les valeurs sont toujours des chaînes de caractères.
data object
Les champs normalisés de la source, ainsi que useDomain et targetSpecies avec leurs justificatifs.
region string | null
Une région infranationale lorsque la source est régionale, sinon null.
retrievedAt string
Date et heure ISO 8601 auxquelles la fiche a été collectée auprès de sa source.
sourceUrl string
Le jeu de données officiel dont provient la fiche.
licence object
La licence de la source : id, url et texte d’attribution à afficher.
limitations string[]
Ce que la source n’établit pas, comme la commercialisation actuelle ou l’éligibilité d’un patient.

Erreurs

Les erreurs renvoient un code de statut et un corps JSON contenant un message d’erreur. Erreurs et limites de requêtes.

Gestion des versions

La version fait partie du chemin. De nouveaux champs et paramètres facultatifs peuvent apparaître dans la v1 : ignorez donc les champs que vous ne connaissez pas.

OpenAPI

Le contrat complet est un document OpenAPI 3.1 que vous pouvez charger dans n’importe quel générateur de clients ou outil d’API. /openapi.json