| layout | permalink | description | hero | title | customLayout | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
default |
link-api |
Développeurs, Datascientists, intégrez l'API décès au sein de vos applications |
|
Intégrer l'API décès |
true |
L'API décès possède deux principales fonctions:
- la recherche unitaire
- l'appariement (liste de personnes à rechercher)
La première sera utile dans un contexte utilisateur (un formulaire dte données de données d'État civil, où l'appel API servira à vérifier la vitalité d'une personne).
La seconde est utile pour compléter le statut vital d'une base de donnée clients au sein d'un système d'information, de plusieurs milliers à environ un million de personnes
La documentation de l'API est réalisée au format OpenApi Specification (OAS3, Swagger).
Elle décrit de façon détaillée les champs et leur format.
Le cas d'usage basique est l'utilisation, de la recherche simple (q=Pompidou...)
depuis la valeur d'un formulaire (input).
Le code suivantci-contre est l'implémentation de cas en Svelte.js. Cliquez sur "output" pour voir le résultat, ou rendez-vous sur ce REPL.
L'exemple utilise l'API search en mode GET, documentée ici.
Sa transposition en POST est simple et préférable pour la robustesse d'un code de production.
L'API unitaire est limité à une requête par seconde. Pour les appariement en masse,
une API search/csv permette le traitement de 50 à 100 requêtes par seconde.
Cette API de soumettre un CSV contenant jusqu'à 1 millions d'identité (100Mo), qui sera complété d'éventuelles détections des données de décès en cas de correspondance celle-ci étant qualifiée par un score de confiance.
Ces données peuvent être retraitées à l'issue pour être injectées dans votre base de donnée.
L'exemple minimaliste suivant est réalisé en Python est disponible sur ce REPL.
{% include algos-link-api.html %}
Nous vous recommandons dans un premier temps de passer par le service en ligne pour tester la validité du fichier et du choix des colonnes à apparier avant d'attaquer le code d'appariement. Vous pourrez, en particulier, vérifier avec l'aide de l'UI de validation.
Dans le cas d'un service métier intégré dans un système d'information, pour des appariement réguliers, nous recommandons d'intégrer une UI de validation telle que celle proposée.En effet, l'UI proposée permet de diviser en moyenne par 10 le temps de validation d'une paire d'identité par rapport à un affichage en colonnes classiques sous un tableur.
Pour traiter un fichie de 100000 lignes, si 10% de personnes sont décédées, environ 9000 seront avec de très bon scores (peu utiles à valider à la main, sauf cas métier nécessitant une assurance complète), et 1000 seront à regarder plus précisément. Ces 1000 cas peuvent prendre moins de 30 minutes avec une UI adaptée, contre une demie jourée sur un tableur.
A ce stade, nous n'avons pas mis à disposition de composant réutilisable pour cette fonction. Néanmoins nos deux implémentations d'interface de validation peuvent vous inspirer: en Svelte.js ou en Vue.js.
Les composants développés implémentent une mise en exergue des différences champs par champ (nom, prénom, ...) entre la donnée cherchée et la donnée de référence INSEE. Cette facilitation visuelle est la source d'accélération de la validation. Nos implémentations reposent sur la librairie diff.js.
L'API est utilisable sans authentification pour un nombre limité d'appels sur l'API de recherche. Pour utiliser l'API au-dela d'une centaine d'appels, ou pour utiliser l'API d'appariement, l'utilisation d'un jeton est nécessaire, tout en restant gratuite.
Voici les étapes si vous voulez automatiser l'obtention de la clé d'API pour un an:
- S'enregistrer et confirmer son identité manuellement sur deces.matchid.io
- Récupérer le jeton dans le menu d'utilisateur (en haut à droite) > API Key. La clé devrait commencer par
eyJhbGc*
Vous pouvez rafraîchir votre jeton initial sans limite de la façon suivante:
-
Pour tout appel à l'API: il suffit d'ajouter le Header:
Authorization: "Bearer accessToken", en remplaçantaccessTokenpar votre jeton. Des limitations demeurent sur la fréquence d'appel (1/s pour la recherche) mais le nombre d'appels devient illimité. -
Pour rafraîchir le jeton : avec ce même Header faire un GET sur
https://deces.matchid.io/deces/api/v1/auth?refresh=true- ne nouveau jeton récupéré permettra de réitérer les opérations jusqu'à 12 mois.
Vous pouvez faire une demande de rafraîchissement tous les jours par exemple, il n'y a pas de limite (il est inutile d'en faire une demande a chaque appel, mais ce peut être à chaque session si vous faites des appels consécutifs de 5 minutes ou même moins).