API Ingres Noyau

Conditions Générales d'Utilisation

Le CISIRH met à disposition cette API exploitable accessible uniquement par les ministères ou institutions ayant accès au Réseau Interministériel de l'Etat (RIE).
Son utilisation par une application tierce ne saurait engager la responsabilité du CISIRH, par exemple, en termes de disponibilité.

• L'API est disponible, ouverte et supervisée 24/24H, hors interruptions de service et de maintenance.
• L'API est couverte de 7H à 20H, du lundi au vendredi, hors jours fériés.
• La présence des équipes de supervision s'étale de 9H à 18H, du lundi au vendredi, hors jours fériés.

Limitations actuelles

Le format de restitution des données est celui défini par le noyau RH FPE. Il s'agit de fichiers XML et de leur équivalent au format Excel.
Une conversion JSON du XML est également proposée, à titre expérimental.
Cette API permet de récupérer automatiquement les fichiers à l'identique de ce qu'ils sont produits et mis à disposition sur le portail PissaRHo (open RH FPE).
Cette API ne permet pas la récupération unitaire d'un code est de ses attributs et peut par conséquent ne pas être adaptée à une API entre appliclations mais tout dépend du besoin.
Pour cet usage, une autre API ("API Ingres Nomenclatures") permet une restitution au format JSON avec des temps de réponse bien meilleurs.

Evolutions possibles

Certaines évolutions ont été demandées par nos partenaires et devraient être disponibles courant 2020.
Par exemple, il sera possible d'obtenir directement la version la plus récente et dans le format noyau le plus récent.
Nous vous proposons donc de nous faire part de vos besoins afin de les étudier et de faire évoluer l’API de façon à ce qu’elle réponde au mieux à vos attentes.

Principe d'utilisation et exemples

L'utilisation de cette API nécessite d'être familiarisé avec le jargon "Noyau".
Pour récupérer une nomenclature, il faut:

• VERSION NOYAU: les fichiers sont publiés mensuellement de façon officielle pour une version noyau donnée. Par exemple, la versin "21.00.04" diffusée en Novembre 2021 est la 4ème version publiée depuis la version structurante 21.00.00 publiée en Juillet 2021).
  Si cette version n'est pas connue, l'API permet de les listes toutes: https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/
  Le plus grand nombre correspond à la version la plus récente disponible.
  Si ce que vous recherchez est un contenu le plus "récent possible" possible, alors choisir la version "HORSVERS" qui correspond à des fichiers produits la veille au soir. Il y a toutefois un écart possible pour les nomenclatures RCC car certaines modifications incluses dans ce fichier pourraient ne pas être validées par la DGAFP.
• FORMAT NOYAU: ce format correspond à la structure XML des fichiers restitués. Chaque version noyau structurante (une par an) porte des évolutions de format, c'est à dire l'ajout, la suppression ou la modification d'attributs (donc de balises XML dans le fichier). Bien qu'il soit recommandé de toujours prendre la version la plus récente, vous pouvez choisir le format qui vous convient, par exemple: la version noyau 21.00.05 avec le format 20.00.00 plutôt que le 21.00.00.
• TYPE DE DIFFUSION: deux choix possibles: "compplete" ou "differentielle" (sans accents!). La version complete restitue tous les codes dans leur dernière version qu'elle qu'elle soit.
  Exemple de mode complet : le fichier des GRADES 21.00.05 complet pourra contenir aussi bien les codes grades modifiés en 21.00.05 que ceux qui n'ont pas été modifiés depuis plusieurs versions mais qui sont toujours en vigueur)
  Exemple de mode différentiel : le fichier des GRADES 21.00.05 différentiel ne contiendra que les codes grades modifiés en 21.00.05.

Liste des référentiels gérés dans Ingres

• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/HORSVERS/21.00.00/complete

Liste des version diffusées (et disponibles)

• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/

Liste des formats (structure noyau) disponibles pour une version donnée

• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/21.00.04

Liste des types de diffusion disponibles pour une version et un format donnés

• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/21.00.04/21.00.00

Liste des nomenclatures disponibles pour une version, un format et un type de diffusion donnés

• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/21.00.04/21.00.00/complete

Récupération au format XML d’une nomenclature pour une version, un format et un type de diffusion donnés

• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/21.00.04/21.00.00/complete/GRADE
  ou
• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/21.00.04/21.00.00/complete/GRADE/xml

Récupération au format Excel d’une nomenclature pour une version, un format et un type de diffusion donnés

• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/21.00.04/21.00.00/complete/GRADE/xls

Récupération au format JSON d’une nomenclature pour une version, un format et un type de diffusion donnés

• https://api.piste.gouv.fr/cisirh/ingres-noyau/v2/21.00.04/21.00.00/complete/GRADE/json