Merge pull request #1626 from etalab/doc-qualibat-rge-qualifelec

Documente API Qualibat / qualifelec par rapport à l'API RGE

config/endpoints/api_entreprise/21_ademe_certifications_rge.yml

@@ -7,11 +7,13 @@
     entity_type_description: |+
       Établissements du secteur de la **rénovation énergétique labellisés RGE** par l'ADEME **depuis 2014** :
       - ✅ **95% des établissements en base chez l'ADEME** sont disponibles au travers de cette API.
-      - ✅ Les certificats RGE des organismes **Certibat, CNOA, Qualibat, Qualifelec, Qualitenr** sont disponibles.
+      - ✅ Les certificats RGE des organismes **Certibat, CNOA, Qualitenr, Qualibat, Qualifelec** sont disponibles.
       - ❌ Les certificats RGE d'Afnor, Cequami, Cerqual, lne et Opqibi ne sont pas disponibles.
 
       Le label RGE (Reconnu Garant de l'Environnement) est délivré à une entreprise qui remplit certains critères lors de la réalisation de travaux d'économie d'énergie dans les logements (_isolation des murs ou de la toiture, installation d'un équipement utilisant  une énergie renouvelable, etc._). Il s'agit d'un dispositif reconnu par l'État.
       En 2021, 64 790 établissements étaient labellisés RGE selon les statistiques données par le [site de data.ademe.fr](https://data.ademe.fr/reuses/nombre-d'entreprises-rge){:target="_blank"}.
+    know_more_description: |+
+     [Différence entre le périmètre de cette API et ceux des API Qualibat ou Qualifelec](#difference-api-qualibat-qualifelec).
     entities:
       - entreprises
       - associations
@@ -140,8 +142,15 @@
         - _Qualibat_ pour des travaux liés à la performance énergétique (construction ou rénovation).
         - _Céquami_ délivre des certifications à des professionnels à même de proposer des travaux de rénovation lourde dans le cadre d'une rénovation énergétique globale du logement.
         - _Certibat_ délivre des certifications aux professionnels du bâtiment en mesure de réaliser des offres globales de rénovation énergétique
+    - q: <a name="difference-api-qualibat-qualifelec"></a>Périmètre de cette API par rapport aux API Qualibat ou Qualifelec
+      a: |+
+        L'API Certification RGE délivre des certificats Qualibat et Qualifelec. Cependant, elle ne couvre que les certifications labellisées RGE et ne vous permet donc pas d'accéder à la totalité des certificats de ces deux organismes. Si vous avez besoin de connaître l'ensemble des certifications Qualibat ou Qualifelec, vous devrez appeler les API suivantes :
+        - [API Certification Qualibat](<%= endpoint_path(uid: 'qualibat/certifications_batiment') %>)
+        - [API Certification Qualifelec](<%= endpoint_path(uid: 'qualifelec/certificats') %>)
   opening: public
   format:
     - Donnée structurée JSON et URL vers le certificat en PDF
   parameters:
     - Numéro de SIRET de l'établissement
+
+

config/endpoints/api_entreprise/22_qualibat_certifications_batiment.yml

@@ -106,7 +106,7 @@
   keywords: *qualibat_keywords
   data:
     description: |+
-      Cette API délivre le certificat Qualibat de l'entreprise au **format PDF** ainsi que de **la donnée structurée extraite** par l'équipe d'API Entreprise directement du PDF<sup>*</sup>, dont les certifications de l'entité et ses assurances responsabilités travaux et civile. 
+      Cette API délivre le certificat Qualibat de l'entreprise au **format PDF** ainsi que de **la donnée structurée extraite** par l'équipe d'API Entreprise directement du PDF<sup>*</sup>, dont les certifications de l'entité et ses assurances responsabilités travaux et civile. Tous les types de certificats Qualibat sont disponibles, [y compris ceux non labellisés RGE](#difference-api-rge).
 
       {:.fr-text--xs}
       <sup>*</sup>Si une des données est absente, une erreur système est ajouté dans la balise `meta`.
@@ -167,3 +167,8 @@
   format:
     - Donnée structurée JSON
   parameters: *qualibat_parameters
+  faq:
+    - q: <a name="difference-api-rge"></a>Périmètre de cette API par rapport à l'API Certification RGE de l'Ademe
+      a: |+
+        L'[API Certification RGE](<%= endpoint_path(uid: 'ademe/certifications_rge') %>) délivre également des certificats Qualibat. Cependant, elle ne couvre que les certifications Qualibat labellisées RGE et ne vous permet donc pas d'accéder à la totalité des certificats Qualibat.
+

config/endpoints/api_entreprise/24_qualifelec_certificat.yml

@@ -40,7 +40,7 @@
     - 'effectif'
   data:
     description: |+
-      Cette API permet d'obtenir **la liste des certificats Qualifelec valides** obtenus par l'établissement. Pour chaque certificat, l'API délivre les données suivantes :
+      Cette API permet d'obtenir **la liste des certificats Qualifelec valides** obtenus par l'établissement. Tous les types de certificats Qualifelec sont disponibles, [y compris ceux non labellisés RGE](#difference-api-rge). Pour chaque certificat, l'API délivre les données suivantes :
       - **informations relatives au certificat** : numéro, dates de validité ;
       - **informations sur la qualification obtenue** : labellisée RGE ou non, libellé, dates de validité, indices, mentions, domaines et la classification qui donne l'effectif du personnel d'execution et d'encadrement disponible pour cette qualification ;
       - **assurances décennale et de responsabilité civile** ;
@@ -64,3 +64,7 @@
     - Numéro de SIRET de l'établissement
   format:
     - Donnée structurée JSON et URL vers le certificat en PDF
+  faq:
+    - q: <a name="difference-api-rge"></a>Périmètre de cette API par rapport à l'API Certification RGE de l'Ademe
+      a: |+
+        L'[API Certification RGE](<%= endpoint_path(uid: 'ademe/certifications_rge') %>) délivre également des certificats Qualifelec. Cependant, elle ne couvre que les certifications Qualifelec labellisées RGE et ne vous permet donc pas d'accéder à la totalité des certificats Qualifelec.