Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ajout des guides d'API.gouv #468

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions pages/api_amenagement-cadastre.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: Récupérer des données par API sur les parcelles et le cadastre
keywords:
- api
- definition
- parcelle
- cadastre
- georisque
- foncier
- cartographie
description: Guide pour comprendre omment récupérer les informations sur le cadastre par le biais d'API
---

# Récupérer des données par API sur les parcelles et le cadastre

## Les API utiles

Les API (ou en anglais *Application programming interfaces*), permettent d’échanger des données entre deux outils ou deux bases de données, afin de construire de nouveaux service numériques.

Plusieurs dizaines d’API sont produites par les administrations françaises pour partager des données, qui sont mises à jour chaque jour, chaque mois ou chaque année.

À partir de ces données, les administrations, entreprises et associations ont la possibilité d’alimenter des outils (tels que des tableaux de bord ou des cartographies) pour piloter plus efficacement les politiques publiques (urbanisme, environnement, développement économique...).

[🔎 En savoir plus sur les API](https://www.data.gouv.fr/fr/pages/api-definition)

### API Géorisques

L’API Géorisques permet d’afficher pour un territoire donné la liste des données et documents relatifs aux risques naturels et technologiques existants.
Elle est développée par le Bureau de Recherches Géologiques et Minières.

L’État met aussi à disposition [l’outil ERRIAL - Géorisques](https://errial.georisques.gouv.fr/), qui permet de remplir plus facilement l’état des risques existants à une adresse.

[➡️ Accéder à l’API Géorisques](TODO)

### API Données foncières

Développée par le CEREMA, l’API Données foncières permet d’accéder aux principales données foncières, d’origine fiscale, enrichies par le Cerema et la direction générale de l’aménagement, du logement et de la nature (DGALN).

- Voir la [liste des usages possibles des données foncières](https://datafoncier.cerema.fr/usages)
- Accéder aux [outils d’observation et d’analyse du foncier](https://datafoncier.cerema.fr/les-outils-dobservation-et-danalyse-du-foncier)

[➡️ Accéder à l’API Données foncières](TODO)

### API Carto - module Cadastre

L’API Carto - module cadastre (par l’IGN) permet d’obtenir les informations suivantes issues de la BD PARCELLAIRE :

- Obtenir les géométries pour une commune
- Obtenir les divisions parcellaires d’une commune
- Obtenir la géométrie d’une parcelle cadastrale
- Obtenir le centroïde d’une parcelle ou d’une commune (localisants)

[➡️ Accéder à l’API Carto - module Cadastre](TODO)

### API Camino

L’API Camino permet de connaitre le cadastre minier (la localisation, les substances minières, les titulaires et les administrations en charge pour chaque projet minier).
L’API distribue également le référentiel des substances de mines inscrites au code minier.

[➡️ Accéder à l’API Camino](TODO)

## Pourquoi intégrer ces API dans vos outils ou sites internet ?

Les API permettent d’accéder à des données et les intégrer dans des outils et sites internet.

Par exemple, pour afficher des informations cadastrales sur un site ou dans un logiciel métier, l’intégration d’une API permettra d’automatiser sa mise à jour.

**De manière générale, les API permettent :**
- ⏱ de disposer des données les plus récentes (grâce à l’accès direct à une base de données de référence),
- 🤖 d’automatiser la mise à jour de données, sites web, tableaux de bord,
- ✅ d’utiliser une donnée certifiée à la source,
- 🔎 de filtrer ou afficher une seule information parmi un grand ensemble de données,
- 📂 de ne pas télécharger et stocker soi-même les fichiers et jeux de données.

### Comment les intégrer ?

1. Accédez à la documentation des API que vous souhaitez utiliser ;
2. Testez l’API avec différents paramètres d’appel ;
3. Générez un jeton d’appel propre à votre usage ;
4. Intégrez l’URL de l’API dans votre système d’information, et paramétrez les appels possibles.

67 changes: 67 additions & 0 deletions pages/api_authentification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: Les API dédiées à l'authentification des personnes et des organisations
keywords:
- api
- franceconnect
- identite
- sante
- proconnect
- santeconnect
- pro
- openid
- siret
- siren
- acces
- securite
- authentification
- bouton
description: API permettant d'authentifier les particuliers et les organisations
---

# Les API dédiées à l'authentification des personnes et des organisations

## Dans quel cas l'authentification des personnes ou des organisations est nécessaire ?

### 🙋🏽‍♀️ Démarches administratives des particuliers

Lors d'une démarche administrative, les administrations doivent s'assurer que la personne qui saisit ses informations en ligne est authentifiée.
Le couple identifiant / mot de passe est une solution, mais elle comporte des limites (multiplication des mots de passe), et la gestion de la sécurité des comptes nécessite un investissement humain et technologique conséquent.

**Le bouton France Connect vise à simplifier l'authentification des particuliers**, qui sont de plus en plus nombreux à disposer d'un compte France Connect.

Une fois implémenté par l'administration, il permet non seulement de garantir une authentification sécurisée pour les usagers, mais également de **récupérer les données nécessaires à la démarche** (données fiscales, statut étudiant ou boursier, statut demandeur d'emploi, attestation de droits de la CNAM, etc...)

[🔎 En savoir plus sur FranceConnect les API FranceConnectées](https://www.data.gouv.fr/fr/pages/api_franceconnectees)

### 🏛️ Connecter des professionnels

Certaines applications veulent pouvoir identifier des professionnels, que ce soit par exemple pour des démarches, du logiciel bureautique, des accès à des données.

Plutôt que de demander des justificatifs et de les vérifier manuellement, ProConnect permet d'**obtenir l'identité de la structure** : Numéro SIRET, code Commune (COG), Code d'activité (NAF), etc... et de **vérifier automatiquement l'adresse e-mail** (correspondance du nom de domaine et vérification de la réception des e-mails).

- [ProConnect](https://www.proconnect.gouv.fr/) pour les professionnels,
- [Pro Santé Connect](https://esante.gouv.fr/produits-services/pro-sante-connect) pour les professionnels de la sphère sanitaire et sociale.


## Quelles API utiliser pour authentifier des personnes ou des organisations ?

| Population | FranceConnect | ProConnect | ProSantéConnect |
|----------------------------------------|---------------|--------------|-----------------|
| Particuliers | ✅ | ❌ | ❌ |
| Professionnels | ❌ | ✅ | ✅ |
| Professionnels de la santé | ❌ | ✅ | ✅ |
| Entreprises | ❌ | ✅ | ❌ |
| Agents de l'administration centrale | ❌ | ✅ | ❌ |
| Agents des collectivités territoriales | ❌ | ✅ | ❌ |


## Comment accéder aux API ?

Les API d’authentification sont réservées aux administrations et à leurs éditeurs.

#### [🇫🇷 API FranceConnect](TODO)

#### [🏛️ API ProConnect](TODO)

#### [🏥 API Pro Santé Connect](TODO)

55 changes: 55 additions & 0 deletions pages/api_definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Qu’est-ce qu’une API ?
keywords:
- api
- definition
description: Page vulgarisant le terme "API"
---

# Qu'est ce qu'une API ?

API est un acronyme qui signifie (en anglais) _Application Programming Interface_, ce qui n’est... vraiment pas très clair !

## Commençons par une analogie

Vous souvenez vous des annuaires téléphoniques ?

⇢ Un **annuaire téléphonique** permet à un **humain**, de demander une information à un autre **humain**, par **téléphone**.

Sur le web, les API jouent le même rôle que les annuaires. Sauf que le téléphone est remplacé par internet et les humains par des ordinateurs.

⇢ Une **API**, permet à un **ordinateur** de demander une information à un autre **ordinateur**, par **internet**.

## Et maintenant un exemple

C'est un peu abstrait tout ça. Rien ne vaut un bon exemple !

<ApiSireneWidget title='Un exemple d’API : l’API Sirene' />

Dans cet exemple, votre ordinateur, utilise internet, pour demander à un autre ordinateur, des informations à propos des entreprises françaises.

## Et dans l’administration qu'est-ce que cela signifie ?

L'administration regorge d'API. Elles permettent d'échanger des données entre deux administrations ou entre une administration et une entreprise privée, afin de construire de nouveaux service numériques ou de simplifier une démarche en ligne.

### Des API ouvertes : en accès libre

La majorité des API visibles sur la page [rechercher une api](/rechercher-api) sont des API libres d'accès. On parle aussi d'API en opendata, ce qui veut dire que les données sont ouvertes et publiques. Elles peuvent vous permettre d'accèder à des données comme :

- l'ensemble des [adresses du territoire français](/les-api/base-adresse-nationale)
- les Diagnostic de Performance Energetique des logements particuliers (DPE)
- la [base documentaire Gallica](/les-api/api_gallica_document), de la Bibliothèque Nationale de France
- la [liste des jours fériés en France](/les-api/jours-feries)

... Et encore [bien d'autres](/rechercher-api).

### Des API en accès restreint

D'autres API sont en accès restreint. Cela veut dire que seules les entitées éligibles peuvent les utiliser. Ce sont celles qui permettent d'accéder à des données sensibles, qu'il faut protéger. Comme par exemple :

- l'API Impôt particuler qui donne accès aux données fiscales des citoyens. Elle est utile pour simplifier de les démarches des citoyens.
- l'API Entreprise qui donne accès aux administrations aux données des entreprises. Elle est utile pour simplifier les démarches des entreprises.

### On est prêt pour les détails !

A partir d’ici, ca devient un peu plus technique et vous en savez déjà bien assez pour [découvrir la liste des API disponibles dans le service public](/rechercher-api)
75 changes: 75 additions & 0 deletions pages/api_franceconnectees.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Les API FranceConnectées
keywords:
- api
- franceconnect
- identite
- pivot
- bouton
description: Guide pour comprendre ce qu'est une API FranceConnectée, quel est leur intérêt et leur fonction
---

# Les API FranceConnectées

[🔎 En savoir plus sur les API](https://www.data.gouv.fr/fr/pages/api-definition)
[➡️ Accéder à l’API Géorisques](TODO)

[FranceConnect](https://franceconnect.gouv.fr/) permet au citoyen de s'authentifier à de nombreux services de l'administration. Ce dispositif permet d'utiliser un compte existant sur impots.fr ou ameli.fr par exemple, afin d'accéder à tous les services de l'administration.


Les API FranceConnectées sont des API, **en accès restreint et souvent accessibles uniquement aux administrations**, qui permettent d'accéder aux données administratives d'un particulier. **Leur particularité est de proposer une modalité d'appel via FranceConnect**. Elles permettent alors de transmettre - _en plus des données d'identité pivot de FranceConnect_ - d'**autres données personnelles du citoyen**.

**Concrêtement, prenons un usager effectuant une démarche en ligne :** L'usager commence sa démarche, il a besoin de renseigner des justificatifs administratifs. Le service en ligne lui propose de s'authentifier, et met à disposition le bouton "Se connecter via FranceConnect". En cliquant et en confirmant suite au parcours FranceConnect, il permet à FranceConnect de transmettre ses données d'identité directement à une API FranceConnectée qui retourne alors les données qu'elle détient.

## Qui peut accéder à ces API FranceConnectées ?

Globalement, seules les administrations peuvent utiliser les API FranceConnectées.

Dans le détail, en tant qu'organisation proposant une démarche en ligne, il faut être éligible et effectuer une demande d'habilitation auprès de :
- **FranceConnect pour implémenter le bouton FranceConnect**. Toute administation ou collectivité est éligible, et dans des cas spécifiques, certaines entreprises et associations le sont aussi. Pour en savoir plus, consulter la [documentation de FranceConnect](https://franceconnect.gouv.fr/partenaires) ;
- **Administration en charge de l'API FranceConnectée**, et pouvoir expliquer en quoi le cas d'usage de la démarche justifie d'accéder aux données personnelles de cette API.


## À quoi servent-elles ?

Les API FranceConnectées simplifient les démarches en ligne d'un usager, car elles lui évitent la saisie de données personnelles utilisées comme paramètres d'appel aux API (par exemple : le _numéro fiscal_ sert de paramètre d'appel pour les API fiscales et doit être saisi par l'utilisateur si la démarche n'utilise pas d'API FranceConnectée). C'est l'identité pivot fournie par FranceConnect qui fait office de modalité d'appel pour une API FranceConnectée, le usager n'a donc rien à saisir.

**Le parcours d'un usager dans une démarche avec API en modalité d'appel classique :**

- 👤 Connexion par son compte associé à la démarche
- 🔍 Recherche du paramètre demandé dans ses documents personnels (par exemple _le numéro fiscal_ ou _nom, prénom, date et lieu de naissance_)
- 🗝 Saisie de ce ou ces paramètre(s)
- 👩‍💻 Récupération de données par API

**Le parcours grâce aux API FranceConnectées :**

- 🇫🇷 Connexion par FranceConnect
- ✅ Récupération de données grâce aux API FranceConnectées

**Les API FranceConnectées simplifient :**

| La démarche du usager | Le traitement de l'agent |
| ------------------------------------------- | --------------------------------------------------------------- |
| Des démarches simplifiées et accélérées | Les délais de traitement sont instantanés |
| Plus aucune pièces justificatives à fournir | Plus de pièces justificatives à traiter et à stocker |
| Plus d'erreur de saisie possible | Plus de fraude possible car la donnée est certifiée à la source |

## Un cas pratique : la demande d'Aide Juridictionnelle

_Témoignage du Ministère de la Justice :_

> L'aide juridictionnelle est une prise en charge par l'État des frais judiciaires, réservée aux revenus les plus modestes. Grâce à la vérification des revenus avec l'API Impot Particulier FranceConnectée, ce sont 1,2 millions de formulaires CERFA qui seront soumis en ligne en lieu et place d'un dossier papier !

## Comment fonctionnent-elles techniquement ?

_Schéma de fonctionnement des API FranceConnectées :_
![Fonctionnement des API FranceConnectées](https://franceconnect.gouv.fr/images/how-it-works-data.svg)

## Comment accéder aux API FranceConnectées ?

Les API FranceConnectées ne sont accessibles qu’aux administrations publiques, collectivités territoriales ou entreprises privées en situation de mission de service public. Elles nécessitent de :

1. Avoir FranceConnect [sur son téléservice](https://franceconnect.gouv.fr/partenaires)
2. Faire une demande d'habilitation à l’API FranceConnectée en question
3. Brancher l’API
4. 🎉 Commencer à dématérialiser 🥳