Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.2 KB

ajouter-une-api.md

File metadata and controls

42 lines (26 loc) · 2.2 KB
layout
pages

Ajouter votre API

Vérifiez l'éligibilité de votre API en consultant les critères ci-dessous :

Eligibilité d'une API sur API.GOUV.fr

Finalité

Etre produite et exploitée par une autorité administrative. Cela inclut les administrations de l’Etat (centralisées et décentralisées), les collectivités territoriales, les établissements publics à caractère administratif, les organismes gérant des régimes de protection sociale relevant du code de la sécurité sociale et du code rural ou mentionnés aux articles L. 223-16 et L.351-21 du code du travail et les autres organismes chargés de la gestion d'un service public administratif.

Présenter un intérêt pour des réutilisateurs publics ou privés.

Exigences

  • avoir une description fonctionnelle claire et succincte de l'API à renseigner sur API.GOUV,
  • avoir une documentation technique en ligne et claire,
  • disposer d'une procédure en ligne pour demander l'accès à l'API si elle n'est pas totalement ouverte.

Le critère d'acceptation principal est de pouvoir tester l'API en moins d'une journée et de l'intégrer en moins d'une semaine.

Bonnes pratiques

  • fournir une documentation sous le format OPEN API
  • fournir des exemples pertinents démontrant l'utilisation de l'API
  • fournir une page de statistiques publique exhibant les volumétries pertinentes pour l'API concernée (nombre de hits, mais surtout mesures sectorielles comme nombre de courses de taxi (le.taxi), nombre de candidatures simplifiées aux marchés publics (API Entreprise) ...
  • décrire simplement les modalités d'accès à l'API (CGU, licence ..) et simplifier au maximum l'enrôlement
  • avoir un environnement Bac à sable pour tester facilement l'API

Utiliser Github

Si vous êtes familier avec GitHub, vous pouvez suivre les consignes décrites dans le fichier CONTRIBUTING.MD du dépot de ce site.

Nous contacter

Si vous n'êtes pas familier avec GitHub, vous pouvez nous communiquer vos coordonnées sur [email protected] afin que nous vous recontactions.