n8n Beginner Course (2/9) - Introduction to APIs and Webhooks

Summary

Dans cette vidéo du cours pour débutants sur les API et les Webhooks, nous explorons les concepts clés de l'API, en utilisant l'analogie d'un restaurant pour expliquer son fonctionnement. Une API est un moyen pour les développeurs d'interagir avec des services comme Google Sheets. Nous discutons également des composants essentiels d'une requête HTTP, tels que l'URL, la méthode, l'en-tête et le corps, et expliquons comment l'authentification fonctionne. Enfin, nous abordons les Webhooks, qui permettent de recevoir des informations en temps réel, contrairement à l'interrogation régulière d'une API. Cette vidéo est un guide essentiel pour commencer à créer des workflows d'automatisation.

Takeaways

• 💡 Une API (Application Programming Interface) est une interface qui permet à différentes applications de communiquer entre elles sans exposer toute leur complexité interne.
• 🍽️ L’analogie du restaurant illustre bien le rôle de l’API : le serveur (interface) transmet la demande du client (utilisateur) à la cuisine (application) et renvoie la réponse.
• 📚 La documentation d’une API joue le rôle du menu au restaurant : elle décrit les services disponibles et comment les utiliser.
• 🌐 Une requête HTTP comporte quatre éléments principaux : l’URL, la méthode, l’en-tête (header) et le corps (body).
• 🔍 L’URL identifie la ressource à atteindre sur le web, comprenant le schéma, l’hôte, le chemin et parfois des paramètres de requête.
• 🚦 Les méthodes HTTP décrivent l’action à effectuer : GET pour obtenir des données, POST pour en envoyer, et d’autres comme PUT, DELETE ou PATCH pour des cas spécifiques.
• 🧾 Les en-têtes (headers) fournissent des informations supplémentaires comme le type de contenu ou les préférences de langue.
• 🔐 Les identifiants ou « credentials » authentifient les utilisateurs, souvent via une clé API ou le protocole OAuth pour sécuriser l’accès aux services.
• 📬 Une réponse HTTP contient un code d’état (comme 200, 401, 404, 500), un en-tête de réponse et parfois un corps avec les données renvoyées.
• 🔔 Un web hook (ou API inversée) permet à une application d’envoyer automatiquement des informations lorsqu’un événement se produit, au lieu de devoir interroger régulièrement le serveur.
• ⚙️ Les web hooks sont très utiles pour déclencher des workflows automatisés dès qu’un changement ou un événement est détecté dans une application.

Q & A

Qu'est-ce qu'une API?

Une API (Interface de Programmation d'Applications) permet à un programme d'interagir avec un autre programme ou service en exposant des services accessibles via une interface. Cela permet aux développeurs de consommer ces services pour effectuer des actions spécifiques comme récupérer ou envoyer des données.

Comment une API fonctionne-t-elle en utilisant l'analogie du restaurant?

Dans cette analogie, l'API est comparée à un serveur dans un restaurant. Le client (vous) fait une demande au serveur (interface), qui la transmet à la cuisine (application). Une fois la commande prête, le serveur retourne la réponse au client, tout comme une API renvoie les données ou informations demandées.

Quels sont les composants principaux d'une requête HTTP?

Une requête HTTP comprend quatre composants principaux: l'URL (emplacement unique d'une ressource), la méthode (l'action à effectuer, comme GET ou POST), l'en-tête (détails ou contexte supplémentaires), et le corps (informations envoyées, notamment dans une requête POST).

Quelle est la différence entre les méthodes GET et POST dans une requête HTTP?

La méthode GET est utilisée pour récupérer des informations à partir d'une ressource, tandis que la méthode POST permet d'envoyer des informations vers une ressource, comme lorsqu'on soumet un formulaire.

Pourquoi les en-têtes HTTP sont-ils importants?

Les en-têtes HTTP fournissent des informations contextuelles supplémentaires pour la requête, telles que la langue préférée, la localisation ou le type de contenu souhaité. Cela aide le serveur à répondre de manière appropriée.

Qu'est-ce que le corps d'une requête HTTP?

Le corps d'une requête HTTP contient des données envoyées au serveur, mais il n'existe que pour les requêtes POST. Par exemple, lors de l'envoi d'un formulaire, le corps contiendrait des informations comme le prénom, le nom et l'adresse e-mail.

Quels sont les codes de statut HTTP les plus courants?

Les codes de statut HTTP les plus courants sont : 200 (OK, requête réussie), 401 (Non autorisé, problème d'authentification), 404 (Page non trouvée, problème avec l'URL), et 500 (Erreur interne du serveur).

Qu'est-ce qu'un Webhook et comment cela fonctionne-t-il?

Un Webhook est un mécanisme inverse à l'API. Contrairement à une requête régulière, où le client demande des informations, le Webhook envoie automatiquement des informations lorsqu'un événement se produit, comme un paiement réussi sur Stripe, sans que le client ait besoin de faire une demande.

Pourquoi utiliser un Webhook au lieu de faire des requêtes répétées?

L'utilisation d'un Webhook est plus efficace que de faire des requêtes répétées (polling) car il permet au serveur d'envoyer immédiatement des informations lorsque l'événement se produit, évitant ainsi de surcharger le serveur avec des demandes inutiles.

Quelles sont les deux méthodes courantes pour s'authentifier lors d'une requête API?

Les deux méthodes courantes d'authentification sont : l'utilisation de paramètres de requête (ex : ?apikey=xxx) ou l'authentification par en-tête (ex : Authorization: Bearer xxx). Une autre méthode courante est l'authentification OAuth, souvent utilisée pour les connexions via des services comme Google.