Skip to content

Commit

Permalink
Merge pull request #186 from ansforge/update_quick_start
Browse files Browse the repository at this point in the history
add table for API subscription
  • Loading branch information
zilliw committed May 28, 2024
2 parents ddbb193 + bd39e99 commit fab081c
Showing 1 changed file with 25 additions and 27 deletions.
52 changes: 25 additions & 27 deletions docs/pages/quick-start/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>Souscrire à l'API</b>
**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 |
&nbsp;
| 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 |

<b>Se connecter à l'API</b>
**Se connecter à l'API**

|ETAPES| DESCRIPTION |
|1| Utiliser l'API KEY "<b>ESANTE-API-KEY</b>" 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) |
&nbsp;
| 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) |

<b>Les liens d'accès</b>
|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 |
&nbsp;
**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 |

## <a id="one-header"></a>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"}.

## <a id="two-header"></a>2) Création d'un compte dans Gravitee
La création d'un compte est obligatoire dans l'outil GRAVITEE.
Expand All @@ -51,29 +49,27 @@ La création d'un compte est obligatoire dans l'outil GRAVITEE.
</div>
&nbsp;


## <a id="three-header"></a>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.

<p align="center">
<img src="img/apim_creer_app.png" style="width:100%;">
</p>

Pour créer une application, les étapes à réaliser sont :

<div class="wysiwyg" markdown="1">
* 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
</div>
&nbsp;


| 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 |
&nbsp;

<div class="wysiwyg" markdown="1">
* 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
Expand All @@ -86,13 +82,15 @@ Pour créer une application, les étapes à réaliser sont :

## <a id="four-header"></a>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.

<div class="wysiwyg" markdown="1">
* <b>Test 1</b> : 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) :
</div>
&nbsp;

TIPS| Pour la suite de l'exercice, vous devez remplacer {{site.ans.demo_key }} par votre clé d'API.


<div class="code-sample"><div class="tab-content" data-name="bash">
{% highlight bash %}
curl -H "ESANTE-API-KEY: {{site.ans.demo_key }}" "{{site.ans.api_url}}/fhir/metadata?_pretty=true&_format=json"
Expand Down

0 comments on commit fab081c

Please sign in to comment.