diff --git a/docs/pages/changelog/changelog.md b/docs/pages/changelog/changelog.md index af4ea70..a12bb93 100644 --- a/docs/pages/changelog/changelog.md +++ b/docs/pages/changelog/changelog.md @@ -7,7 +7,7 @@ Le changelog documente les modifications associées à une version de l’API F **Versions disponibles de l'API FHIR Annuaire Santé** -| Version API FHIR | Version IG | Date de lancement | Disponible jusqu'à | -| --- | --- | --- | --- | -| 1 (Beta) | 0.1.0 - trial use | 5 septembre 2022 | TBD | -| 2 | 1.0.1 | TBD | TBD | +| Version API FHIR | Version FHIR | Version IG | Date de lancement | Disponible jusqu'à | +| --- | --- | --- | --- | --- | +| 1 (Beta) | R4 | 0.1.0 - trial use | 5 septembre 2022 | TBD | +| 2 | R4 | 1.0.1 | TBD | TBD | diff --git a/docs/pages/documentation/starters/postman-starter.md b/docs/pages/documentation/starters/postman-starter.md index 05a6a0a..0cf995f 100644 --- a/docs/pages/documentation/starters/postman-starter.md +++ b/docs/pages/documentation/starters/postman-starter.md @@ -3,14 +3,14 @@ layout: documentation title: Utilisation de Postman --- -Vous pouvez utiliser cette collection Postman pour tester l'API via des exemples d'appels FHIR. +Vous pouvez utiliser cette collection Postman avec des exemples d'appels FHIR pour tester l'API. [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/8078261-a496d05a-e735-4211-9844-31b45ba5e6dd?action=collection%2Ffork&collection-url=entityId%3D8078261-a496d05a-e735-4211-9844-31b45ba5e6dd%26entityType%3Dcollection%26workspaceId%3D0376a555-c1a8-4912-9cb4-4945375d85e8#?env%5BProd%5D=W3sia2V5IjoiYXBpX2tleSIsInZhbHVlIjoiWFhYWC1YWFhYLVhYWFgtWFhYWCIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiWFhYWC1YWFhYLVhYWFgtWFhYWCIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJhcGlfdXJsIiwidmFsdWUiOiJodHRwczovL2dhdGV3YXkuYXBpLmVzYW50ZS5nb3V2LmZyL2ZoaXIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vZ2F0ZXdheS5hcGkuZXNhbnRlLmdvdXYuZnIvZmhpciIsInNlc3Npb25JbmRleCI6MX1d) ### Configuration de la clé d'API -Une fois le projet importé dans votre espace Postman, vous devez renseigner les variables se trouvant dans "Environnements > Prod". +Une fois le projet importé dans votre espace Postman, vous devez renseigner les variables se trouvant dans le menu "Environnements > Prod".

@@ -18,7 +18,8 @@ Une fois le projet importé dans votre espace Postman, vous devez renseigner les Voici les variables utilisées dans le projet Postman: -| Variable | Description | Valeur | -|----------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| -| api_key | Clé d'API (Si vous n'avez pas de clé, veuillez suivre la procédure décrite [ici](/annuaire-sante-fhir-documentation/pages/quick-start/quick-start.html)) | Saisissez votre clé | -| api_url | L'url d'accès à l'API | https://gateway.api.esante.gouv.fr/fhir | +|Variable|Description|Valeur| +|---|---|---| +|api_key|Clé d'API (Si vous n'avez pas de clé, veuillez suivre la procédure décrite [ici](/annuaire-sante-fhir-documentation/pages/quick-start/quick-start.html))|Saisissez votre clé +| +|api_url|L’url d’accès à l’API |https://gateway.api.esante.gouv.fr/fhir| diff --git a/docs/pages/guide/version0-1/quick-start.md b/docs/pages/guide/version0-1/quick-start.md new file mode 100644 index 0000000..885b6bc --- /dev/null +++ b/docs/pages/guide/version0-1/quick-start.md @@ -0,0 +1,25 @@ +--- +layout: documentation +title: Guide de démarrage rapide avec l'API +--- + +Vous pouvez utiliser cette collection Postman avec des exemples d'appels FHIR pour tester l'API. + +[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/8078261-a496d05a-e735-4211-9844-31b45ba5e6dd?action=collection%2Ffork&collection-url=entityId%3D8078261-a496d05a-e735-4211-9844-31b45ba5e6dd%26entityType%3Dcollection%26workspaceId%3D0376a555-c1a8-4912-9cb4-4945375d85e8#?env%5BProd%5D=W3sia2V5IjoiYXBpX2tleSIsInZhbHVlIjoiWFhYWC1YWFhYLVhYWFgtWFhYWCIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiWFhYWC1YWFhYLVhYWFgtWFhYWCIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJhcGlfdXJsIiwidmFsdWUiOiJodHRwczovL2dhdGV3YXkuYXBpLmVzYW50ZS5nb3V2LmZyL2ZoaXIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vZ2F0ZXdheS5hcGkuZXNhbnRlLmdvdXYuZnIvZmhpciIsInNlc3Npb25JbmRleCI6MX1d) + + +### Configuration de la clé d'API + +Une fois le projet importé dans votre espace Postman, vous devez renseigner les variables se trouvant dans le menu "Environnements > Prod". + +

+ +

+ +Voici les variables utilisées dans le projet Postman: + +|Variable|Description|Valeur| +|---|---|---| +|api_key|Clé d'API (Si vous n'avez pas de clé, veuillez suivre la procédure décrite [ici](/annuaire-sante-fhir-documentation/pages/quick-start/quick-start.html))|Saisissez votre clé +| +|api_url|L’url d’accès à l’API |https://gateway.api.esante.gouv.fr/fhir|