From bd39e992e5a654ed252797c0dc73e23b9a0e1fc1 Mon Sep 17 00:00:00 2001 From: William AZIS Date: Tue, 28 May 2024 17:41:42 +0200 Subject: [PATCH] add table for API subscription --- docs/pages/quick-start/quick-start.md | 52 +++++++++++++-------------- 1 file changed, 25 insertions(+), 27 deletions(-) diff --git a/docs/pages/quick-start/quick-start.md b/docs/pages/quick-start/quick-start.md index e788471..60840fe 100644 --- a/docs/pages/quick-start/quick-start.md +++ b/docs/pages/quick-start/quick-start.md @@ -14,32 +14,30 @@ title: Guide de démarrage rapide avec l'API Ce guide explique comment obtenir une clé d'API et la configurer pour effectuer votre premier appel à l'API. -Souscrire à l'API +**Souscrire à l'API** -|ETAPES| DESCRIPTION | -|---|---| -|1| Créer votre compte personnel sur l'API manager de l'ANS: [GRAVITEE](https://portal.api.esante.gouv.fr){:target="_blank"}. | -|2| Créer l'application qui a vocation à se connecter à l'API dans GRAVITEE | -|3| Obtenir un jeton depuis l'application créée dans GRAVITEE | -  +| ETAPES | DESCRIPTION | +| --- | --- | +| 1 | Créer votre compte personnel sur l'API manager de l'ANS: [GRAVITEE](https://portal.api.esante.gouv.fr){:target="_blank"}. | +| 2 | Créer l'application qui a vocation à se connecter à l'API dans GRAVITEE | +| 3 | Obtenir un jeton depuis l'application créée dans GRAVITEE | -Se connecter à l'API +**Se connecter à l'API** -|ETAPES| DESCRIPTION | -|1| Utiliser l'API KEY "ESANTE-API-KEY" et le jeton récupéré par GRAVITEE | -|2| Effectuer des requêtes API en utilisant le démonstrateur API ou en utilisant des logiciels gratuits (ex: Postman) | -  +| ETAPES | DESCRIPTION | +| --- | --- | +| 1 | Utiliser l'API KEY "**ESANTE-API-KEY**" et le jeton récupéré par GRAVITEE | +| 2 | Effectuer des requêtes API en utilisant le démonstrateur API ou en utilisant des logiciels gratuits (ex: Postman) | -Les liens d'accès -|NOM| LIEN URL | -|---|---| -|Serveur d'accès au service| https://gateway.api.esante.gouv.fr/fhir | -|URL d'accès au Démonstrateur API| https://portail.openfhir.annuaire.sante.fr | -  +**Les liens d'accès** + +| NOM | LIEN URL | +| --- | --- | +| Serveur d'accès au service | https://gateway.api.esante.gouv.fr/fhir | +| URL d'accès au Démonstrateur API | https://portail.openfhir.annuaire.sante.fr | ## 1) 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](https://portal.api.esante.gouv.fr/catalog/api/962f412b-e08e-4ee7-af41-2be08eeee7f6){:target="_blank"}. +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](https://portal.api.esante.gouv.fr/catalog/api/962f412b-e08e-4ee7-af41-2be08eeee7f6){:target="_blank"}. ## 2) Création d'un compte dans Gravitee La création d'un compte est obligatoire dans l'outil GRAVITEE. @@ -51,29 +49,27 @@ La création d'un compte est obligatoire dans l'outil GRAVITEE.   - ## 3) Création d'une application dans Gravitee -Cette étape consite à créer une application dans GRAVITEE afin d'obtenir une clé API. +Cette étape consiste à créer une application dans GRAVITEE afin d'obtenir une clé API.

Pour créer une application, les étapes à réaliser sont : +
* Connectez-vous sur le portail Gravitee à l'adresse : [IDENTIFIEZ-VOUS](https://portal.api.esante.gouv.fr/user/login){:target="_blank"} * Dans l'onglet "Applications", cliquer sur "CREER UNE APP". La création de l'application se fait en trois étapes
  - | ETAPES | DESCRIPTION | | --- | --- | -| GENERAL| Renseigner le nom de l'application, une description, le domaine utilisé par l'application et une image | -| SECURITE | Saisir le type (web, mobile, etc.) et le client_ID (facultatif) | +| GENERAL | Renseigner le nom de l'application, une description, le domaine utilisé par l'application et une image | +| SECURITE | Saisir le type (web, mobile, etc.) et le client_ID (facultatif) | | SOUSCRIPTION | Chercher l'API suivante: API Annuaire Santé en libre accès et cliquer sur "Souscrire" et "Suivant" | | FINALISATION | Cliquer sur "Créer l'application" pour terminer | - 
* Dans le menu "Application" dans l'onglet "Souscriptions", vous pourrez retrouver toutes les API souscrites. En cliquant dans le tableau sur l'une des API, la clé API à utiliser s'affiche @@ -86,13 +82,15 @@ Pour créer une application, les étapes à réaliser sont : ## 4) Tester l'API Pour ces premiers tests, nous utilisons cURL pour plus de simplicité. [cURL](https://curl.se/) é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) : +* **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 {{site.ans.demo_key }} par votre clé d'API. +
{% highlight bash %} curl -H "ESANTE-API-KEY: {{site.ans.demo_key }}" "{{site.ans.api_url}}/fhir/metadata?_pretty=true&_format=json"