Structure de base et présentation de l’URL

Last modified: 27. juin 2022

Structure de l’API

L’API est appelée via une URL bien définie. Si un fichier XML est livré par un appel, il peut également être saisi dans une fenêtre de navigateur, par exemple. Le XML qui en résulte est ensuite affiché par le navigateur.

L’URL se compose de :

<Protocole>://<Host>/<Version>/<Méthode>/<Format des données>.<Format de sortie>?<Paramètre>

  1. URL de base de l’API : ‘https://api.itscope.com
  2. Version : la version actuelle est la ‘/2.1
  3. Méthode : commence par exemple par « /products ». Une méthode est par exemple « /search » suivie des filtres décrits dans la syntaxe du chemin d’accès à l’URL
  4. Format des données : par exemple, standard ou developer, décrit dans des formats de données
  5. Format de sortie : les formats de sortie peuvent être CSV, XML ou JSON
  6. Paramètres : séparés du chemin par un  » ? », des informations supplémentaires sont données, par exemple sur le tri ; ceci est décrit dans la syntaxe des paramètres de l’URL.

En rassemblant ces éléments, on obtient le lien vers un appel API, par exemple :

https://api.itscope.com/2.1/products/search/keywords=server%20barebone/standard.xml?sort=DEFAULT

Was this article helpful?
Dislike 0
Views: 35