Guide de démarrage rapide avec l'API

Dans cette page


Ce guide explique comment obtenir une clé d’API et la configurer pour effectuer votre premier appel à l’API.

0) Prérequis pour démarrer avec l’API

Pour appeler l’API, il est nécessaire de disposer d’une clé d’API. Pour obtenir cette clé, vous devez vous rendre sur l’outil de gestion d’API de l’ANS : GRAVITEE.

1) Création d’un compte dans Gravitee

Il s’agit de votre première connexion à l’outil Gravitee, vous devez créer un compte.

  • Rendez-vous sur le portail Gravitee à l’adresse : ENREGISTREZ-VOUS
  • Saisissez votre prénom, votre nom et une adresse email, puis valider votre saisie en cliquant sur le bouton
  • À l’issue de la création de votre compte, un email de confirmation vous est envoyé à l’adresse email que vous avez indiquée. Cet email contient un lien permettant de terminer le processus de validation de votre compte.

 

NOTE L’adresse email est indispensable pour créer un compte dans Gravitee. Si vous n’avez pas d’adresse email, vous devez en créer une.

2) Création d’une application dans Gravitee

Cette étape concerne les utilisateurs qui n’ont pas encore créé d’application à souscrire à l’API. Pour créer une application, vous devez suivre les étapes suivantes :

  • Connectez-vous sur le portail Gravitee à l’adresse : IDENTIFIEZ-VOUS
  • Dans l’onglet “Applications”, cliquer sur “CREER UNE APP”.

 

  • Ensuite, remplissez les informations générales requises pour l’application.

 

  • Pour souscrire votre application à l’API, vous pouvez rechercher “API Annuaire Santé en libre accès”.

 

  • Une fois la création de l’application terminée, une clé d’API vous est automatiquement générée. Celle-ci est disponible dans l’onglet “SOUSCRIPTIONS” de votre Application.

 

3) Tester l’API

Pour ces premiers tests, nous utilisons cURL pour plus de simplicité. cURL étant un outil présent sur la plupart des plateformes windows 10+, macos, linux.

  • Test 1 : lancez la commande suivante pour récupérer le CapabilityStatement FHIR (liste des fonctionnalités de l’API) :

 

TIPS Pour la suite de l’exercice, vous devez remplacer XXXX-XXXX-XXXX-XXXXX par votre clé d’API. 
curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/metadata?_pretty=true&_format=json"
  • La réponse de l’API devrait ressembler à ceci :

 

{
  "resourceType": "CapabilityStatement",
  "fhirVersion": "4.0.1",
  "format": [ "application/fhir+xml", "xml", "application/fhir+json", "json" ],
  "rest": [ {
    ...

    NOTE| Le capability statement permet de connaitre les fonctionnalités disponibles sur le serveur FHIR (paramètres, ressources…).

  • Test 2 : vous pouvez lancer cette requête pour récupérer les ressources “Practitioner” :

 

curl -H "ESANTE-API-KEY: XXXX-XXXX-XXXX-XXXXX" "https://gateway.api.esante.gouv.fr/fhir/Practitioner?_pretty=true&_format=json"
  • La réponse devrait ressembler à cela :

 

{
  "resourceType": "Bundle",
  "entry": [ {
    "fullUrl": "https://.../fhir/v1/Practitioner/pra-59",
    "resource": {
      "resourceType": "Practitioner",
      "id": "pra-59",
    }
  }, {
    "fullUrl": "https://.../fhir/v1/Practitioner/pra-57",
    "resource": {
      "resourceType": "Practitioner",
      "id": "pra-57",
      ...
    }
  }
  ...
  ]
}

 

Aller plus loin

Ressources internes

 

Ressources externes