Comment décrire son API Pull ?

Modifié le  Jeu, 16 Sept., 2021 à 3:14 H

Pour créer une offre par API vous êtes amené à décrire chacune des URLs qui seront disponibles dans cette offre. Pour valider cette étape vous devez indiquer :

  • Un nom : Information purement indicative permettant à vos acquéreurs de comprendre la logique de votre API et les données qui seront disponibles pour cette url
  • URL : URL précise
  • Type de requête : GET ou POST (manière dont sont transmises les informations, en fonction de leur sensibilité)
  • Format de sortie des données : Information indicative, informez vos acquéreurs du format de sortie des données (csv, json, xml, etc.)
  • Paramètres : Les paramètres sont détectés automatiquement lorsque votre URL est enregistrée. Vous pouvez les modifier, en ajouter ou en supprimer.

Trois modes d'envoi sont disponibles : dans l'URL, dans le chemin ou dans le corps de la requête. Chaque paramètre peut être facultatif.

Cet article a-t-il été utile ?

C'est super !

Merci pour votre commentaire

Désolé ! Nous n'avons pas pu vous être utile

Merci pour votre commentaire

Dites-nous comment nous pouvons améliorer cet article !

Sélectionner au moins l'une des raisons
La vérification CAPTCHA est requise.

Commentaires envoyés

Nous apprécions vos efforts et nous allons corriger l'article