search

etalab / entreprise.api.gouv.fr

Site publique d'API Entreprise
https://entreprise.api.gouv.fr
7 stars 7 forks source link

Ajout contenu premiere requete #68

Closed DorineLam closed 3 years ago

DorineLam commented 3 years ago

Que fait cette PR ?

Elle propose d'ajouter une partie à la documentation permettant de guider l'utilisateur sur la méthode à avoir pour faire son premier appel de test

Pourquoi fait-on ça ? Contexte, PR, issue liée ?

Car @brindu a régulièrement des demandes au support, et que cette partie de la doc n'était pas assez précise.

brindu commented 3 years ago

@DorineLam Le contenu est bon pour moi ! Juste pour être sûr, est-ce que cela va remplacer cette partie ?

DorineLam commented 3 years ago

@brindu je n'arrive pas à voir (le lien ne marche pas) de quelle partie tu parles .. 😬 Mais a priori je ne remplace pas une partie, j'en ajoute une ^^

brindu commented 3 years ago

Humm il y a des ratés avec le bouton pour copier /coller le lien, ça donne ça quand je copie le lien vers la partie en question : entreprise.api.gouv.fr/https://entreprise.api.gouv.fr/doc/#premiere-requete

C'est de cette partie là que je voulais parler : https://entreprise.api.gouv.fr/doc/#premiere-requete. C'est dans cette partie qu'il manque le jeton en paramètre dans la doc pour que la requête fonctionne bien (ce dont on parlait hier).

DorineLam commented 3 years ago

@brindu Merci, est-ce que le jeton peut-être considéré comme un paramètre de traçabilité ? Si non, je vais changer le titre. ou bien ajouter un paragraphe pour expliciter aux utilisateurs que les infos sur la construction d'une requête se trouvent ici : https://entreprise.api.gouv.fr/doc/#apis

brindu commented 3 years ago

Je ne suis pas certain de comprendre ce que tu veux faire. En l'état, la doc tuto "faire ma première requête" va échouer pour l'usager car nul part dans cette partie il n'est indiqué qu'il faille fournir le jeton dans la requête, juste faut indiquer ici qu'il faut fournir son jeton. Je ne comprends pas pourquoi tu pourquoi à chaque fois que je dis ça tu parles de changer une autre partie de la doc au lieu de simplement rajouter le jeton dans la liste des paramètres à fournir dans la requête dans cette partie ; j'ai l'impression de ne pas être compris 😅

Sinon oui le jeton est un outil de traçabilité car il identifie l'utilisateur, mais ce n'est pas un "paramètre obligatoire" au sens où on l'entend pour le suivi des requêtes faites à API Entreprise.

DorineLam commented 3 years ago

@brindu Évolution dans le dernier commit, en attente de ton feedback ! :)

DorineLam commented 3 years ago

@brindu est-ce que je peux te demander de l'aide pour résoudre les conflits et merger cette PR ?