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

Initie la fiche métier carif-oref #1265

Merged
merged 27 commits into from
Dec 27, 2023
Merged

Conversation

DorineLam
Copy link
Contributor

No description provided.

@linear
Copy link

linear bot commented Oct 17, 2023

Copy link
Contributor Author

@DorineLam DorineLam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changements

_data/api/api_quiforme.md Outdated Show resolved Hide resolved
_data/api/api_quiforme.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Charlottecho Charlottecho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DorineLam :
*J'ai rajouté une section "source de données " de l'API . J'ai également crée une issue Linéar pour modifications doc site API entreprise . + value de savoir que cette API regroupent plusieurs sources de données => fiable .

  • J'ai laissé volontairement les sections en rouge , ce que cela n'inclut pas En mode "TODO" pour vérifier avec le FD
  • Mode TODO : url datapass + swagger à demander FD
  • La mise en forme du tableau est un 1 er jet ( beaucoup d'informations et j'ai tenté la police en gras pour faire ressortir les données principales mais pas top .. ) => j'hésite à réduire les informations en faisant 1 tableau classé / 3 parties :
    1- Informations identité : Siret , UAI, Nda
    2- Certifications Qualiopi
    3- Habilitations France compétences
    S'ils veulent en savoir + => go sur la doc API entreprise ( bizdev API entreprise +++ )

Qu'en penses tu ?

Copy link
Contributor Author

@DorineLam DorineLam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Première partie de revue, avant de regarder le tableau de données

_data/api/api_quiforme.md Outdated Show resolved Hide resolved
- Particulier
- Education
- Entreprises
- Formation
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tu peux choisir uniquement dans les thèmes suivants :

  • Administration
  • Administration & législation
  • Agriculture
  • Culture
  • Droit & Justice
  • Education
  • Emploi
  • Energie
  • Entreprise
  • Environnement
  • Géographie
  • Particulier
  • Professionnels
  • Santé
  • Sécurité
  • Transport

(à ce sujet, je suis en train de faire une PR pour proposer des templates/guides => https://github.com/betagouv/api.gouv.fr/pull/1270/files)

J'aurai donc mis en plus de entreprise et administration :

Suggested change
- Formation
- Education
- Administration & législation
- Professionnels

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merci pour la PR des templates/guides ❤️

themes:
- Particulier
- Education
- Entreprises
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Entreprises
- Entreprise

---

Cette API, délivrée directement par le Ministère de l'éducation nationale, permet de vérifier si un particulier est scolarisé au primaire, au collège ou au lycée, et savoir s'il est boursier.
Votre service utilisera d'autres API ? Retrouvez les données de cette API dans le bouquet d'API distribué par la DINUM [API Particulier](les-api/api-particulier).
Cette API, délivrée directement par le réseau des Cariforef, permet de vérifier si un établissement est habilité à délivrer un formation certifiante Qualiopi et/ou France compétences.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Cette API, délivrée directement par le réseau des Cariforef, permet de vérifier si un établissement est habilité à délivrer un formation certifiante Qualiopi et/ou France compétences.
Cette API, délivrée directement par le réseau des Carif-Oref, permet de vérifier si un établissement est habilité à délivrer une formation certifiante, en accédant au certificat Qualiopi et aux habilitations France compétences.

_data/api/api_quiforme.md Outdated Show resolved Hide resolved
_data/api/api_quiforme.md Outdated Show resolved Hide resolved
_data/api/api_quiforme.md Outdated Show resolved Hide resolved
_data/api/api_quiforme.md Outdated Show resolved Hide resolved
@@ -0,0 +1,109 @@
---
title: API Quiforme
tagline: Certifications Qualiopi et habilitations France compétences
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pour uniformiser avec les autres API :

Suggested change
tagline: Certifications Qualiopi et habilitations France compétences
tagline: Vérifiez si un établissement est habilité à former en récupérant ses certifications Qualiopi et habilitations France compétences.

@DorineLam
Copy link
Contributor Author

@Charlottecho voici ce que ça donne en l'état, après restructuration du tableau des données :

image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DorineLam : 2 questions stp pour que je puisse terminer cette fiche :
1- Sur le site api.gouv , on référence l'API directement distribuée par Cariforef et non pas celle sur API entreprise : on maintient Base sirene et BAN normalement selon moi ( selon leur doc métier )
2- Les 📍"to-do" que tu as inscrites : je m'en charge ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1- Oui exactement
2- Oui je veux bien

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DorineLam , voici les retours et questions que j'aies pour toi avant d' envoyer email au FD pour demandes infos supplémentaires :

  • 📍 Volumétrie maximale de votre API. => Peux tu vérifier stp si cela est dans le swagger ? selon moi , non

  • doc_tech_link: https://api-quiforme.intercariforef.org/docs#/ => OK

  • doc_tech_external: https://TODO # 📍 URL vers la documentation technique de l'API => c’est quoi ?

  • monitoring_link: https://TODO # 📍URL de la page de statut de l'API => Pas dispo de leur côté

  • themes: # 📍 Ajouter un ou plusieurs thèmes, qui permettront aux usagers de trouver votre API en filtrant le catalogue par thématique. Pour ajouter un thème ci-dessous, supprimer simplement le # (sans retirer des blancs.) => Est-ce que l’on peut rajouter des « nouveaux thèmes » ?

    • Administration
  • - Administration & législation

  • - Agriculture

  • - Culture

  • - Droit & Justice

  • - Education

  • - Emploi

  • - Energie

    • Entreprise
  • - Environnement

  • - Géographie

  • - Particulier

  • - Professionnels

  • - Santé

  • - Sécurité

  • - Transport

  • last_update: 10/10/2023 /TODO => Kesako ?

  • Sources de données

    • Le reférentiel UAI/SIRET de l'Onisep (MAJ DORINE : API référencée sur api.gouv est celle de cariforef en direct donc j'inclus la BAN ? )=> j’ai rajouté la base sirene + BAN
    • Base SIRENE
    • Base Adresse nationale
    • Certificats Qualiopi ( DGEFP , Liste OF )
    • Habilitations France compétences ( France Compétences, RNCP, RS )
      -Les modifications demandées par Sabrina ont été MAJ => peux tu vérif stp ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DorineLam , voici les retours et questions que j'aies pour toi avant d' envoyer email au FD pour demandes infos supplémentaires :

  • 📍 Volumétrie maximale de votre API. => Peux tu vérifier stp si cela est dans le swagger ? selon moi , non

  • doc_tech_link: https://api-quiforme.intercariforef.org/docs#/ => OK

  • doc_tech_external: https://TODO # 📍 URL vers la documentation technique de l'API => c’est quoi ?

  • monitoring_link: https://TODO # 📍URL de la page de statut de l'API => Pas dispo de leur côté

  • themes: # 📍 Ajouter un ou plusieurs thèmes, qui permettront aux usagers de trouver votre API en filtrant le catalogue par thématique. Pour ajouter un thème ci-dessous, supprimer simplement le # (sans retirer des blancs.) => Est-ce que l’on peut rajouter des « nouveaux thèmes » ?

    • Administration
  • - Administration & législation

  • - Agriculture

  • - Culture

  • - Droit & Justice

  • - Education

  • - Emploi

  • - Energie

    • Entreprise
  • - Environnement

  • - Géographie

  • - Particulier

  • - Professionnels

  • - Santé

  • - Sécurité

  • - Transport

  • last_update: 10/10/2023 /TODO => Kesako ?

  • Sources de données

    • Le reférentiel UAI/SIRET de l'Onisep (MAJ DORINE : API référencée sur api.gouv est celle de cariforef en direct donc j'inclus la BAN ? )=> j’ai rajouté la base sirene + BAN
    • Base SIRENE
    • Base Adresse nationale
    • Certificats Qualiopi ( DGEFP , Liste OF )
    • Habilitations France compétences ( France Compétences, RNCP, RS )
      -Les modifications demandées par Sabrina ont été MAJ => peux tu vérif stp ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DorineLam , voici les retours et questions que j'aies pour toi avant d' envoyer email au FD pour demandes infos supplémentaires :

📍 Volumétrie maximale de votre API. => Peux tu vérifier stp si cela est dans le swagger ? selon moi , non

doc_tech_link: https://api-quiforme.intercariforef.org/docs#/ => OK

doc_tech_external: https://todo/ # 📍 URL vers la documentation technique de l'API => c’est quoi ?

monitoring_link: https://todo/ # 📍URL de la page de statut de l'API => Pas dispo de leur côté

themes: # 📍 Ajouter un ou plusieurs thèmes, qui permettront aux usagers de trouver votre API en filtrant le catalogue par thématique. Pour ajouter un thème ci-dessous, supprimer simplement le # (sans retirer des blancs.) => Est-ce que l’on peut rajouter des « nouveaux thèmes » ?

Administration

  • Administration & législation
  • Agriculture
  • Culture
  • Droit & Justice
  • Education
  • Emploi
  • Energie
    Entreprise
  • Environnement
  • Géographie
  • Particulier
  • Professionnels
  • Santé
  • Sécurité
  • Transport
    last_update: 10/10/2023 /TODO => Kesako ?

Sources de données
Le reférentiel UAI/SIRET de l'Onisep (MAJ DORINE : API référencée sur api.gouv est celle de cariforef en direct donc j'inclus la BAN ? )=> j’ai rajouté la base sirene + BAN
Base SIRENE
Base Adresse nationale
Certificats Qualiopi ( DGEFP , Liste OF )
Habilitations France compétences ( France Compétences, RNCP, RS )
-Les modifications demandées par Sabrina ont été MAJ => peux tu vérif stp ?

Copy link
Contributor Author

@DorineLam DorineLam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

En réponse de tes questions @Charlottecho :

📍 Volumétrie maximale de votre API. => Peux tu vérifier stp si cela est dans le swagger ? selon moi , non

Le champ est disponible mais n'a pas été complété, cf mon commentaire directement dans le code.

doc_tech_external: https://todo/ # 📍 URL vers la documentation technique de l'API => c’est quoi ?

C'est un champ qui permet d'ajouter une URL vers une documentation technique "PDF" ou "Papier", donc une autre doc que le swagger.
Si tu n'en as pas, tu peux mettre le champ en commentaire. Je vais le faire dans le code et te pinguer.

monitoring_link: https://todo/ # 📍URL de la page de statut de l'API => Pas dispo de leur côté

Ok on met en commentaire aussi alors. Idem, je vais te faire une proposition dans le code.

themes: # => Est-ce que l’on peut rajouter des « nouveaux thèmes » ?

Je ne pense pas, les thèmes sont fixes et font référence aux filtres utilisés dans la barre de recherche.

image
  last_update: 10/10/2023 /TODO => Kesako ?

Une date permettant de dire quand a été mise à jour la doc je suppose.

Sources de données Le reférentiel UAI/SIRET de l'Onisep (MAJ DORINE : API référencée sur api.gouv est celle de cariforef en direct donc j'inclus la BAN ? )=> j’ai rajouté la base sirene + BAN Base SIRENE Base Adresse nationale Certificats Qualiopi ( DGEFP , Liste OF ) Habilitations France compétences ( France Compétences, RNCP, RS )

Oui ici faut mettre toutes les sources qu'ils ont indiquées.

Les modifications demandées par Sabrina ont été MAJ => peux tu vérif stp ?

Je regarde ça dans un second temps après ce commentaire.

description: |
En tant que collectivité territoriale ou administration, vous êtes éligible à utiliser cette API selon votre cadre juridique. Vous pouvez déposer une demande d'habilitation :
<Button href="https://datapass.api.gouv.fr/TODO">Demander un accès</Button>
rate_limiting_resume: TODO appels / minute / IP # 📍 Volumétrie maximale de votre API.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Charlotte c'est ici qu'il te faut mettre la volumétrie maximale de l'API, autrement appelée "rate limiting"

Tu peux aussi compléter le "rate_limiting_description" (le champ suivant pour décrire par une phrase la volumétrie) ça apparaîtra comme ça dans la fiche métier :
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dorine : je vais demander au FD . On peut merger et MAJ l'info après ?

_data/api/api_quiforme.md Outdated Show resolved Hide resolved
_data/api/api_quiforme.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@DorineLam DorineLam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revérification que les retours ont bien été pris en compte. c'est tout bon pour moi :)

_data/api/api_quiforme.md Outdated Show resolved Hide resolved
En attente volumétrie de la part du FD pour MAJ fiche .

Co-authored-by: DorineLam <[email protected]>
@skelz0r skelz0r force-pushed the api-1251-ajout-fiche-carif-oref branch from c7a7d23 to 914222b Compare December 22, 2023 16:16
@Charlottecho Charlottecho reopened this Dec 27, 2023
@skelz0r skelz0r merged commit 38a4f53 into master Dec 27, 2023
11 checks passed
@skelz0r skelz0r deleted the api-1251-ajout-fiche-carif-oref branch December 27, 2023 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants