betagouv/api.gouv.fr

Liste les API disponibles au sein de l'administration française

api.gouv.fr's Issues

La recherche n'est pas pertinente

remonté des tests utilisateurs du 03/05

Pour reproduire :
Rechercher quotient familiale remonte le.taxi
Rechercher entreprise ne remonte pas API Entreprise

Fixer les formulaires d'ajout d'API et de réutilisation

Evolutions sur la partie détail d'une API

Remontées utilisateurs sur les pages de détail de l'ancienne version :

• Mettre plus d'informations dans le détail
• Mettre systématiquement un lien vers la documentation de l'API
• disponible sous contrat : le contrat est ou ?, que puis je faire/pas faire avec l'API
• ajouter 'cette API est utilisée par XXX'
• ajouter 'pour utiliser cette api, contactez xxx'
• ajouter un bouton 'prévenez moi si les conditions d'utilisation changent'. Ainsi, si cette api devient disponible pour plus de monde, le prospect est averti.
• Est ce que seuls les appels temps réel sont disponibles ? puis je utiliser en batch/lot ?
• quelles sont les étapes pour l'utiliser ?
• il y a deux types d'api : celles qui ont une documentation qqpart et les autres,
  • pour celles avec de la doc : proposer un guide avec les sujets à couvrir
  • pour celles sans doc proposer un template
    Objectif : aider les fournisseurs à donner les informations minimums nécessaire au futur consommateur pour savoir si il peut faire affaire.
• Ajoutez un bouton 'on vous contacte' avec formulaire nom/mail
• Mettre un lien vers une API mock ou demo
• Mettre un lien vers le swagger de l'API
• Augmenter la disticntion entre l'API et ses réutilisations
• Mettre un rappel de la catégorie de l'API (code couleur par ex)

Ajouter une procédure de demande d'API par les consommateurs potentiels

Sauf erreur de ma part, pour l'instant il est possible pour une administration d'ajouter une API existante, mais il n'y a pas de guidelines pour solliciter la mise à dispo d'une API pour quelqu'un qui n'aurait pas trouvé son bonheur dans la liste.

Use case:

• Je découvre le site api.gouv.fr en cherchant une API spécifique pour enrichir mon service
• Je consulte la liste des API déjà dispo
• Il n'y a pas ce qu'il me faut
• Au lieu de fermer l'onglet et d'oublier api.gouv.fr pour un moment, je peux exprimer mon besoin (par exemple en créant une issue GitHub avec un template défini )
• l'équipe d'api.gouv.fr peut évaluer/transmettre la demande et ainsi identifier des nouveaux gisements de valeur
• d'autres consommateurs potentiels de l'API peuvent trouver le ticket et confirmer la demande par un commentaire ou par un subscribe ou avoir l'explication du pourquoi c'est pas encore dispo ou pourquoi ça ne le sera pas...

Plus mettre en valeur le champ de recherche ?

Seules la moitié des personnes utilisent la barre de recherche. Doit-on plus la mettre en valeur ?

Tous les liens extérieurs doivent s'ouvrir dans un nouvel onglet

Remonté des tests utilisateurs

Update le.taxi API

TODO

• Mettre à jour la description
• Faire remonter l'utilisation de l'API
• Utiliser le logo carré

Rendre découvrable les API par une machine avec une méta-API

Possibilité :

• apisjson
• json-ld
• json-ld + hydra

Uniformisation des CGU

S'inspirer de tldrlegal.com pour proposer une simplification des CGU

Liens pointants vers des 404

Quand on clique sur l'une des 4 api depuis la page http://sgmap.github.io/api.gouv.fr/api/
on a une 404 (par exemple pour api carto http://sgmap.github.io/api/api-carto.html)

PS : Pour arriver sur la page http://sgmap.github.io/api.gouv.fr/api/
je viens de http://api.gouv2.fr/ en cliquant sur "Explorer les 4 api disponibles"

Remplacer Algolia par une recherche locale en JSON

Permet la recherche sur les serveurs temporaires déployant des branches de test.
Diminue la dépendance à des acteurs externes, cf. https://github.com/sgmap/beta.gouv.fr/wiki/Developpement#usage-de-services-commerciaux-externes.

Ajouter un menu

Il est difficile de naviguer dans le site (particulièrement dans les pages, apropos, qu'est qu'une API).
Je propose d'ajouter un menu avec les 4 catégories.

Définir une API

• utiliser le thread Octo
• Utiliser une métaphore : prise électrique

Expliquer la différence entre les données (Open Data) et API

Proposer une meilleure explication entre le site api.gouv.fr et data.gouv.fr.

GitHub Pages version is illegal

According to the README:

gem install github-pages -v 2.4.8

But:

$ gem install --user github-pages -v 2.4.8
ERROR:  Could not find a valid gem 'github-pages' (= 2.4.8) in any repository

Améliorer l'accessibilité du site

Retour par mail :

• Il faudrait ajouter l’attribut lang=’fr’ sur l’élément html (sinon la vocalisation des pages avec les lecteurs d’écran se fait avec la voix anglaise)
• Le champ de recherche n’a pas de label, ni de bouton de validation

Il y a d’autres points d’amélioration pour que le site réponde aux exigences d’accessibilité, je pourrais renvoyer au RGAA, mais ce n’est pas le document le plus pédagogique pour entrer dans le sujet.

Je recommanderais plutôt les notices accede-web bien plus facile à lire. Par exemple Html Css Javascript/ :

• http://www.accede-web.com/notices/html-css-javascript/3-langues/3-1-attribut-lang-balise-html/
• http://www.accede-web.com/notices/html-css-javascript/7-formulaires/7-2-title-aria-label-champs-sans-intitule/

C’est très bien fait, on trouve de nombreux exemples de code et explications et c’est en français.

Retour Utilisateurs sur la partie "c'est quoi api.gouv.fr"

Quelques retours en vrac sur cette partie, actuellement supprimée.

Proposition de plan :

1. La promesse : simplifier, éviter les doubles saisies, et ne pas donner de justificatifs
2. Le public cible du site : avant tout les utilisateurs d'API, pas que profil dev. (comment je consomme) mais aussi juriste (j'ai le droit d'utiliser ?)
3. les possibilités offertes : accéder à telle ou telle donnée avant utiliser tel ou tel service

Simplifier jugé plus important que authentifier ou géocoder,
Authentifier était jugé trop technique,

Rendre la recherche plus explicite

Il faut comprendre sur quel critère notre recherche a matché

Déplacer l'indicateur « featured »

Pour que les zones de responsabilité soient claires, un service ne devrait pas pouvoir spécifier s'il est featured. Il s'agit d'un choix éditorial qui devrait être indépendant du service lui-même.

Dans beta.gouv.fr, par exemple, c'est la page d'index qui spécifie les startups qui sont mises en avant, exactement pour cette raison.

Ajouter la documentation technique dans le site

Très possiblement swagger

Passer Swagger en Français

Ajout d'un blog

S'inspirer de beta.gouv.fr

Contact

Problème : les usager contacte le site et non les producteur d'API

Solution : mettre en évidance un moyen de contact par API

Rendre plus claires les conditions d'acceptation pour les différentes API ouvertes sous contrat

Problème

Nous recevons beaucoup de mail demandant si des entreprises privés peuvent avoir accès aux API Entreprise et Particulier.

Solutions

Il doit être possible de lire les conditions derrière les licences OUVERT sous contrat

Mettre en place des tests fonctionnels

Pour prévenir des régressions, il faut mettre en place des tests fonctionnels

Être notifié de l'ajout d'une API

retour de reddit

Il y a un autre moyen de suivre l'avancement, les ajouts d'API, tout ça

Proposition

• flux RSS
• newsletter

Mieux gérer les images

• avoir la possibilité de linker des images extérieures
• harmoniser la gestion des images entre les services et les API

Ajouter un bouton : Ajouter une Réutilisation

Supprimer la marge dans le logo

Supprimer toute la marge à gauche du logo
@MattiSG Je n'ai pas les polices, est-ce que tu peux le regénérer sur ta machine sans la marge ?

Bug d'alignement

Avec la dernière version de Firefox, les cartes des services ne sont pas alignées

Services : Remonter la description au dessus de l'image

Déplacer le lien "Explorer les X API ..."

Remonter le lien actuellement tout en bas de la page,
Au choix : juste en dessous du champ de recherche, ou entre les 4 catégories d'API et les réutilisations mises en valeur

Bundle is not consistent

$ bundle install
[…]
Bundle complete! 4 Gemfile dependencies, 63 gems now installed.
Use `bundle show [gemname]` to see where a bundled gem is installed.
$ bundle exec jekyll serve
Could not find rake-11.2.2 in any of the sources
Run `bundle install` to install missing gems.

Ajouter une définition d'une API

remonté des tests utilisateurs

Fournir un planning de lancement d'API

Des retours utilisateurs nous demande quelle est le planning de lancement des différentes API.

Il faut plus insister sur le caractère disponibles des API

Documenter l'API de api.gouv.fr

L'API est disponible api.gouv.fr/api.json

• Faut-il référence l'API en elle-même dans le site en tant qu'API de l'administration ?
• Faut-il ajouter un simple lien dans le footer avec un swagger ?

Modifier la description sous 'données de référence'

Toujours retours des tests utilisateurs

• la notion de donnée de référence tabulaire n'est pas comprise
• plus que l’accès à la donnée de référence, le besoin est la circulation de cette donnée : éviter la saisie en pré remplissant le champ à mettre en avant plutot que l'auto complétion

Evolutions sur la partie liste des API

Remontées des tests utilisateurs, sur la page actuelle http://sgmap.github.io/api.gouv.fr/api/

• Ajouter un tri,
  • au moins sur les 4 catégories présentées sur la première page
  • éventuellement sur des tags présent dans le détail d'une api
  • éventuellement avec un champ libre qui filtre dynamiquement les réponses présentées en dessous

Affichage d'une Réutilisation

Les utilisateurs cliquent sur le label de l'API et non sur le nom ou l'image de la réutilisation

Proposition : mettre le titre au dessus de l'image

Trouver les réutilisations grâce à la barre de recherche

Voir la documentation search de semantic-ui.

Distinguer visuellement les réutilisations des APIs.

Logo SVG décallé

Le logo ne s'affiche pas de la même manière dans firefox et dans chrome.
@MattiSG tu as une idée ?

Service pas de couleur

Terme Stable versus expérimental

Pas bien compris

Ajouter un bouton : Ajouter une API

Ajouter une page 404

Limiter la place que prennent les statistiques

Réutilisations

Le terme réutilisation n'est pas clair, il faut le modifier et/ou ajouter une description de ce que c'est.

C'est remonté des tests utilisateurs fait le 03/05.
Croyance sur le sujet :

• Outil pour expliquer les API
• tutoriel pour les API
• API mais avec des données bidons

ping @ppezziardi @patama

Mise à jour de l'affichage swagger

• Déplier les catégories
• Cacher le bouton Valid

Evolutions sur la partie 'ils l'utilisent déjà"

• Faire comme data.gouv : un catalogue de dataset (ici les API) et un catalogue de reutilisation (ici les 'Services')
• proposer à des éditeurs ou producteurs de services pour une mise en valeur de leur produit : ne mettre en 1st page que quelques réutilisations et un lien "explorer les X réutilisations" en dessous
• proposition d’ajouter la même chose pour les API : mise en valeur de quelques API (les plus utiles ou plus utilisés ou les plus récentes)
• dans la liste des reuses, proposition de faire apparaitre les services au fur et a mesure du scroll (comme des produits sur amazon)

désactiver le enter sur la recherche

Si aucune APi n'est selectionner sur la recherche, et qu'on appuie sur enter on arrive sur une page 404