API EtOH

Qu’est ce qu’une API ?

Il s’agit d’un service vous permettant d’effectuer des requêtes ou bien de manipuler des ressources web, principalement des données textuelles, sur différents systèmes. Que ce soit pour une application web ou une application mobile, les différents services qui y ont recours pourront traiter les mêmes données.

Schéma explicatif du fonctionnement d'une API

Pourquoi utiliser une API ?

L’intérêt de notre API est de mettre à votre disposition des données dans un environnement sécurisé sans avoir à vous soucier du fonctionnement ou de la complexité de son architecture. Pour cela, nous mettons à votre disposition une documentation détaillée, étape par étape, afin que vous puissiez vous familiariser avec son utilisation.

Comment bien démarrer

1. Il vous faut tout d’abord une clé API. Pour cela, vous devez remplir le formulaire de contact afin que nous puissions vous en envoyer une.Cette clé est unique, elle servira à vous  authentifier auprès de notre API.

Ce code sera stocké sur un fichier, lui même stocké sur le serveur où est hébergé votre site internet. Ce fichier contient un programme qui communiquera avec l’API, afin de fournir en retour, côté client (  navigateur ), un jeton d’identification temporaire. De cette manière, votre clé restera à l’abri des potentiels utilisateurs mal intentionnés sur le serveur.

2. Un fois votre clé API reçue, entrez-la dans ce champ, dans notre documentation, à la place du mot “string” et cliquez sur le bouton “execute”, afin qu’il vous retourne un jeton d’authentification.

De cette manière, vous pourrez tester directement la clé, ainsi que les services de l’API dans un environnement de test.

Récupération du token étape 1
3. Cliquez sur le bouton “Authorize” en haut à droite de la page, une fenêtre modale apparaît. Copiez/collez ce jeton dans ce champ et enfin cliquez sur le bouton “Authorize”.
Clé API étape 2
4. Vous pouvez désormais tester les différentes requêtes à votre disposition, en ajoutant/modifiant les paramètres que vous souhaitez.

Exemple : Je souhaite que l’on me suggère 3 plats en fonction du plat entré, ici “poisson”, en paramètre.

  • Cliquez sur le bouton “Try it out”
  • Entrez le nom du plat dans le champ “pattern”
Clé Api exemple 1
  • Cliquez sur le bouton “execute” qui est apparu en dessous du champ
  • Vous pouvez voir les résultats dans la partie “Response”. Vous pouvez aussi retrouver l’URL complète de la requête.
clé API exemple 2

Vous trouverez ci-dessous des exemples concernant le serveur de production de l’API (l’adresse ou url est différente), et non pas celui de la documentation, qui sert essentiellement d’exemple.

Pour y accéder, cliquez ici.

Page suivante