WordPress est un puissant système de gestion de contenu (CMS) qui s’accompagne d’un gigantesque écosystème de thèmes et d’extensions. Vous disposez ainsi d’un nombre presque illimité de possibilités pour étendre les fonctionnalités de votre site. Toutefois, le mot-clé est « presque ». Pour les cas où vous souhaitez étendre les capacités de votre site d’une manière différente, les API tierces seront la réponse.

Dans cet article, nous allons explorer les avantages de l’utilisation d’API tierces avec WordPress. Tout au long de l’article, nous examinerons les différents types d’API disponibles, des conseils pour choisir quelque chose de convenable, et plus encore. La partie principale de l’article explorera comment utiliser des API tierces avec un site web WordPress hébergé par Kinsta.

Il y a beaucoup à faire, alors commençons !

Ce que sont les API tierces

Une interface de programmation d’application (API) est un ensemble de règles et de protocoles permettant à différentes applications de communiquer et d’interagir. Les API sont des intermédiaires car elles vous permettent d’accéder à des données spécifiques provenant de services externes.

Une fois que vous avez accès aux données disponibles, vous pouvez les intégrer dans vos propres applications. L’approche typique consiste à utiliser un langage approprié, tel que cURL, JavaScript, Python ou PHP.

Un extrait de code de l'API Tinify de TinyPNG.
Un extrait de code de l’API Tinify de TinyPNG.

WordPress propose des API de première partie, telles que l’API REST. Celles-ci exposent des « points de terminaison » dans le code principal pour permettre aux développeurs de s’y connecter. Cela vous donne souvent plus de possibilités et de flexibilité que l’utilisation d’une extension.

Bien entendu, Kinsta fournit également une API REST pour se connecter et travailler avec sa plateforme en dehors du tableau de bord MyKinsta. Cela vous permettra de réaliser des tâches telles que la récupération de journaux de serveur, la configuration de sites web, et plus encore.

Lorsque vous utilisez l’API d’une plateforme pour accéder à ses points de terminaison, il s’agit d’une première partie. En revanche, l’utilisation d’une API d’un service au sein d’un autre service en fait une tierce partie. Par exemple, vous pouvez accéder aux points de terminaison de l’API Météo d’OpenWeatherMap dans le code de votre site WordPress.

La page de l'API Météo d'OpenWeather.
La page de l’API Météo d’OpenWeather.

Comme vous pouvez vous en douter, cela peut ouvrir le champ de ce que vous pouvez réaliser avec WordPress, Kinsta et votre site.

Les avantages de l’utilisation d’API tierces avec WordPress

L’utilisation d’extensions avec WordPress est, bien sûr, un atout majeur de la plateforme. Néanmoins, l’intégration d’API tierces sur votre site présente également de nombreux avantages. Le plus important est que vous pouvez « coder en dur » presque toutes les fonctionnalités que vous souhaitez dans votre site.

Ce n’est pas tout, mais en général, une API vous donnera plus de puissance potentielle et de polyvalence que WordPress et ses extensions ne peuvent en fournir.

Voici quelques autres avantages clés :

  • Vous pouvez économiser du temps de développement. Il est plus rapide d’exploiter une API tierce existante pour développer des fonctionnalités que de partir de zéro. Cela devrait vous faire gagner du temps et vous permettre de vous concentrer sur d’autres projets.
  • Vous pouvez personnaliser l’expérience utilisateur (UX). Il est possible de réaliser toutes les fonctionnalités que les utilisateurs souhaitent voir sur le site selon vos spécifications exactes en utilisant des API tierces.
  • L’efficacité du projet sera renforcée. Les API vous permettent d’automatiser et de rationaliser les processus. Par exemple, vous pouvez intégrer une API de marketing par e-mail pour synchroniser et automatiser les données des utilisateurs vers une plateforme appropriée.
  • La maintenance n’est pas de votre ressort. Le développeur d’une API tierce en assure la maintenance et la mise à jour. Vous avez ainsi accès aux dernières fonctionnalités et améliorations sans avoir à investir des ressources supplémentaires.

Les API tierces sont précieuses partout où vous souhaitez bénéficier d’une intégration, d’une personnalisation et de performances optimales. Bien sûr, ce sera votre seule option si aucune extension WordPress n’est disponible pour répondre à vos besoins.

En général, cependant, si l’utilisateur a besoin de personnaliser la fonctionnalité, par exemple en ajustant les réglages, une extension fonctionnera mieux. Néanmoins, vous aurez de nombreuses possibilités d’intégrer des fonctionnalités à votre site à l’aide d’API tierces.

Les types d’API tierces que vous pouvez trouver

Dans l’ensemble, la demande d’API est énorme. Un rapport de Google Cloud indique qu’environ 60 % des applications web utilisent des API. Le même rapport indique que la majorité des dirigeants pensent que les API les aident à créer de meilleurs produits.

Même s’il peut être difficile de juger de la valeur objective des API tierces, il est clair qu’elles ont de nombreux cas d’utilisation subjectifs. Par extension, les API tierces disponibles répondent à différents besoins et fonctionnalités :

  • API pour les réseaux sociaux. Presque toutes les plateformes, telles que Facebook, Twitter, TikTok et Instagram, fournissent des API. Cela vous permet d’intégrer le partage social, les options de connexion, l’intégration et d’autres fonctions sociales.
  • API de passerelle de paiement. Vous trouverez de nombreuses passerelles de paiement dotées d’API. Par exemple, Stripe et PayPal vous permettront d’intégrer ces services dans votre site WordPress.
  • API de cartographie. Avec des services tels que Google Maps et Mapbox, vous pouvez intégrer des cartes interactives, appliquer la géolocalisation et ajouter des itinéraires à votre site.
  • API d’analyse. Vous avez l’embarras du choix en matière d’analyse. Les API de Google sont encore une fois populaires ici, car de nombreux propriétaires de sites cherchent à intégrer Lighthouse et des données d’analyse à WordPress.
  • API de marketing par e-mail. Des services tels que Mailchimp et SendGrid vous permettent également d’intégrer leurs API à WordPress. Cela vous permet d’automatiser les campagnes d’e-mailing, de gérer les abonnés, de suivre les performances, et bien plus encore.
  • API météorologiques. Grâce aux API de sites tels que OpenWeatherMap et Weatherbit, vous pouvez fournir des données météorologiques en temps réel. Compte tenu de la complexité dont vous avez besoin, il est possible d’ajouter des éléments tels que la géolocalisation.

Cette liste de types d’API n’est pas exhaustive, et il existe d’innombrables autres API disponibles à des fins diverses. Compte tenu de la richesse des options, il est essentiel de choisir la bonne API à intégrer. C’est ce que nous allons faire avant d’étudier comment intégrer des API tierces dans WordPress.

Comment choisir les API tierces adaptées à vos besoins ?

Tout comme vous disposez d’une liste d’options pour choisir une extension WordPress, vous ferez de même pour choisir la bonne API tierce. Il est important de choisir vos intégrations avec soin, car cela déterminera l’orientation de votre projet.

Votre première préoccupation est d’identifier les fonctionnalités dont votre site a besoin. Cela semble évident, mais vous devez rechercher des API qui offrent la bonne combinaison de caractéristiques et de fonctionnalités pour vous.

Toutefois, d’autres facteurs doivent être pris en compte lors du choix d’API tierces :

  • Fiabilité et réputation. Il s’agit ici de vérifier les avis des utilisateurs, les évaluations et les antécédents du fournisseur. En combinant ces éléments, vous saurez s’il a la réputation de fournir des services fiables.
  • Documentation et support. La qualité de la documentation vous aidera à accéder aux points de terminaison. Le niveau d’assistance fourni par le fournisseur d’API vous permettra de gagner du temps et de réduire vos efforts de dépannage.
  • Prix. Toutes les API ne sont pas gratuites. Certaines proposent des niveaux gratuits avec des limitations, tandis que d’autres utilisent un modèle de tarification premium. Veillez donc à aligner votre budget, le cout de l’API, l’utilisation prévue et l’accès.
  • Sécurité et confidentialité. La protection des données des utilisateurs est cruciale lors de l’utilisation d’une API tierce. Il s’agit d’un aspect que vous devez évaluer avec des normes élevées. Vous devez examiner la sécurité employée par une API et vérifier si elle adhère aux normes de protection des données de l’industrie. Accordez des points supplémentaires si l’API est conforme aux réglementations en vigueur en matière de confidentialité des données.

Une API est souvent une solution à long terme, ce qui signifie qu’elle doit être utile quelle que soit la taille de votre site. Voyons cela plus en détail.

Évolutivité

L’API que vous avez choisie doit être capable de gérer l’augmentation du trafic et de l’utilisation au fur et à mesure que votre site web se développe. Cette évolutivité est une considération essentielle, c’est pourquoi nous avons choisi de nous y attarder un peu plus ici.

L’API doit pouvoir fonctionner quel que soit le niveau de trafic de votre site. Toutefois, il est souvent difficile de déterminer si une API peut être utilisée. Il se peut que vous deviez faire une supposition éclairée en vous basant sur la façon dont le fournisseur d’API décrit son offre.

Par exemple, les API « sans état » utilisent une conception de serveur plus simple et disposent d’une certaine flexibilité en ce qui concerne les ressources de traitement. La mise à l’échelle horizontale ajoute davantage de nœuds et de machines au réseau de serveurs. Vous disposez ainsi d’autant de ressources que vous en avez besoin, contrairement à la mise à l’échelle verticale. l’asynchronisme permet au serveur de traiter plusieurs requêtes à la fois, ce qui est plus efficace.

Différence visuelle entre une configuration non évolutive et une configuration horizontale polyvalente.
Différence visuelle entre une configuration non évolutive et une configuration horizontale polyvalente.(Crédit photo : Nithin Mohan)

Vous devriez également vérifier si une API limite le nombre de requêtes qu’elle peut traiter. À long terme, vous obtiendrez ainsi un service plus cohérent, plus fiable et plus stable en cas de charge élevée.

Néanmoins, vous devrez évaluer tous ces facteurs avec soin. Choisir les bonnes API tierces qui répondent à vos besoins sera un avantage lorsque vous chercherez à les intégrer à WordPress.

Pratiques typiques et conseils pour intégrer des API tierces à WordPress

L’intégration d’une API dans votre site est souvent simple. Néanmoins, vous avez besoin d’une approche systématique pour vous assurer que l’intégration se fait en douceur.

La première chose à faire est de lire le manuel complet (RTFM). La documentation de l’API doit être claire sur les fonctionnalités avec lesquelles vous pouvez jouer. Il ne s’agit pas seulement de détails sur les points de terminaison, les réglages et les méthodes d’authentification disponibles.

La documentation de l'API Kinsta
La documentation de l’API Kinsta

Cependant, il y a beaucoup d’autres conseils et pratiques typiques pour réussir l’intégration de votre API avec WordPress :

  • Gestion de l’authentification. La plupart des API ont besoin d’informations d’authentification pour accéder à leurs services. Sans cela, vous ne serez pas en mesure d’accéder aux points de terminaison.
  • Implémenter les appels API. WordPress vous offre plusieurs méthodes pour effectuer des appels API, comme l’API HTTP intégrée. Cela vaut la peine de prendre le temps de choisir la méthode qui convient le mieux à vos besoins. Là encore, la documentation de l’API vous aidera.
  • Analyse des réponses de l’API. Les API renvoient des réponses dans différents formats, tels que JSON ou XML. Vous devrez donc analyser et traiter ces réponses d’API dans votre code afin d’extraire et d’utiliser les données.
  • Gestion des erreurs. L’utilisation de mécanismes de gestion des erreurs appropriés peut vous aider à traiter les erreurs de l’API avec élégance. Cela vous permet également d’afficher des messages d’erreur pertinents pour les visiteurs de votre site web.
  • Test et débogage. Comme pour toute application ou mise en œuvre, testez l’intégration de votre API pour vous assurer qu’elle fonctionne comme vous le souhaitez. Des outils tels que Postman ou des outils de développement de navigateur peuvent vous aider à tester les appels d’API et à déboguer les problèmes éventuels.

Enfin, il est important de suivre l’utilisation de votre API. Étant donné que les couts sont souvent liés à une allocation d’utilisation, vous devez vous efforcer de respecter ces limites. Nous vous montrerons plus loin comment les outils de Kinsta peuvent vous aider à cet égard.

Préparer WordPress et Kinsta à l’intégration d’API tierces

Avant d’intégrer des API tierces à WordPress, il est essentiel que la plateforme et Kinsta soient prêts à les gérer. La configuration de votre CMS et de votre hébergeur peut souvent être nécessaire, en particulier pour un nouveau site.

La bonne nouvelle est que cette étape contient de nombreuses tâches typiques et simples. Par exemple, vous devrez veiller à ce que le noyau de WordPress soit à jour. L’installation de toutes les extensions nécessaires doit également être une priorité. Certaines API peuvent nécessiter des extensions spécifiques pour fonctionner ou servir de « passerelle » vers votre site.

Les questions de sécurité doivent également faire partie de vos préparatifs. L’activation du protocole HTTPS sur votre site par l’installation d’un certificat SSL (Secure Sockets Layer) sera nécessaire.

Les informations SSL pour un certificat Let's Encrypt.
Les informations SSL pour un certificat Let’s Encrypt.

La sauvegarde de votre site doit toujours être effectuée avant tout changement majeur, c’est pourquoi cette étape est une bonne pratique. De plus, vous devez vous demander si vous commencez votre intégration avec un environnement de développement local. Il se peut que certaines extensions ne fonctionnent pas avec une configuration locale.

C’est également le moment d’examiner les limites de votre hébergeur en ce qui concerne l’utilisation d’API tierces. Il peut s’agir de limites de débit ou de ports bloqués. Ces connaissances peuvent vous aider à créer les fonctionnalités dont vous avez besoin de manière optimale.

Par exemple, Kinsta bloque tous les ports SMTP standard, car nous ne fournissons pas d’hébergement de messagerie. Il limite également le nombre de requêtes à 60 par minute. Une fois que WordPress et Kinsta sont optimaux et prêts à fonctionner, vous pouvez commencer à intégrer vos API tierces.

Comment intégrer des API tierces avec WordPress sur Kinsta (2 méthodes)

L’approche habituelle en matière d’intégration d’API tierces consiste à les coder en dur. Ce n’est cependant pas la seule façon de procéder.

Nous allons maintenant examiner les deux approches principales pour intégrer des API tierces avec WordPress sur Kinsta. Commençons par l’approche manuelle, puis examinons les extensions WordPress.

1. Faire des requêtes HTTP à l’API par codage direct

La façon typique de mettre en place des appels API et de gérer les réponses est de les coder dans votre site. Cela nécessite une bonne compréhension du langage de programmation que vous avez choisi et de la structure de WordPress.

Pour les sites WordPress, vous devez utiliser les routes et les points de terminaison de l’API REST. Ceux-ci sont non seulement sécurisés, mais ils offrent également la meilleure intégration avec votre site.

Les API de TikTok sont toutes excellentes, car le codage en dur des fonctionnalités suit une approche typique. Voyons comment procéder.

Intégrer l’API TikTok à WordPress

Tout d’abord, vous devez disposer d’un compte de développeur sur la plateforme. Il s’agit d’une procédure d’inscription rapide, à l’issue de laquelle vous verrez une liste des API disponibles :

Le micro-site de TikTok destiné aux développeurs présente deux des API disponibles.
Le micro-site de TikTok destiné aux développeurs présente deux des API disponibles.

Choisissez l’API qui répond le mieux à vos besoins et consultez la documentation correspondante. Dans cet exemple, nous allons intégrer l’API Display. Elle vous permet de présenter des informations de profil et des vidéos associées :

L'API Display TikTok.
L’API Display TikTok.

Un autre pré-requis est le TikTok Login Kit. Il vous permet d’authentifier votre application de bureau auprès de la plateforme de réseaux sociaux. Cette opération dépasse le cadre de cet article, mais elle implique un processus d’enregistrement et d’approbation.

L’utilisation du kit de connexion est également nécessaire pour obtenir le jeton d’accès au profil spécifique que vous souhaitez afficher :

curl --location --request POST 'https://open.tiktokapis.com/v2/oauth/token/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--data-urlencode 'client_key=CLIENT_KEY' \
--data-urlencode 'client_secret=CLIENT_SECRET' \
--data-urlencode 'code=CODE' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'redirect_uri=REDIRECT_URI'

Avec ce jeton d’accès, vous pouvez appeler GET sur le point de terminaison /v2/user/info/. Vous obtiendrez ainsi des informations de base sur un utilisateur spécifique :

curl -L -X GET 'https://open.tiktokapis.com/v2/user/info/?fields=open_id,union_id,avatar_url' \
-H 'Authorization: Bearer act.example12345Example12345Example'

L’API devrait renvoyer une réponse spécifique contenant toutes les informations pertinentes au format JSON :

{
   "data":{
      "user":{
         "avatar_url":"https://p19-sign.tiktokcdn-us.com/tos-avt-0068-tx/b17f0e4b3a4f4a50993cf72cda8b88b8~c5_168x168.jpeg",
         "open_id":"723f24d7-e717-40f8-a2b6-cb8464cd23b4",
         "union_id":"c9c60f44-a68e-4f5d-84dd-ce22faeb0ba1"
      }
   },
   "error":{
      "code":"ok",
      "message":"",
      "log_id":"20220829194722CBE87ED59D524E727021"
   }
}

Vous devrez analyser cette réponse pour en extraire les données spécifiques que vous souhaitez et les afficher sur l’interface publique. Une fois que vous disposez d’une implémentation fonctionnelle, vous pouvez tester, déboguer et intégrer la gestion des erreurs dans le code. Cependant, il existe également une autre façon de mettre en place des API tierces dans WordPress et Kinsta.

2. Utiliser un plugin WordPress comme solution low-code pour vous connecter à des API tierces

Comme c’est généralement le cas pour WordPress, il existe des extensions qui vous aident à vous connecter à des API tierces de manière rapide et efficace. De plus, il n’est souvent pas nécessaire d’être développeur pour les comprendre et les utiliser. Cela signifie que vous pouvez bénéficier de tous les avantages de la connexion aux API sans avoir besoin de code.

Il existe quelques extensions qui peuvent vous aider, comme Get Use APIs. Notre préférence va à WPGetAPI, qui offre de nombreuses fonctionnalités dans sa version gratuite.

L'image d'en-tête de l'extension WPGetAPI de WordPress.org.
L’image d’en-tête de l’extension WPGetAPI de WordPress.org.

Ensuite, nous allons voir comment utiliser cette extension pour se connecter à une API. Cependant, ces méthodes devraient être transférables à d’autres extensions. Quoi qu’il en soit, après l’installation et l’activation, vous pouvez commencer à ajouter les détails de votre API à l’extension.

Utiliser WPGetAPI pour se connecter à des API tierces

Pour cet exemple, nous allons utiliser l’API Image Optimization de ShortPixel. Rendez-vous à l’écran WPGetAPI > Setup, où vous verrez une multitude de champs vides :

A detailed screenshot of the WPGetAPI plugin interface, showing input fields for the API's name, unique identification, and base URL for integration.
L’écran principal de l’extension WPGetAPI.

Tout d’abord, vous devez spécifier trois éléments : un nom d’API, un identifiant unique et l’URL de base de l’API.

Configuration des informations relatives à l'API de ShortPixel dans WPGetAPI.
Configuration des informations relatives à l’API de ShortPixel dans WPGetAPI.

Une fois que vous avez rempli ces champs et que vous avez cliqué sur le bouton Save, un nouvel onglet apparait pour spécifier les points de terminaison. Les quatre premiers champs de cet écran sont essentiels. Vous devrez fournir un identifiant unique et une URL de point de terminaison, spécifier une méthode de requête et définir un format de résultats :

Configuration d'un appel POST à l'API de ShortPixel dans WPGetAPI.
Configuration d’un appel POST à l’API de ShortPixel dans WPGetAPI.

Pour le menu déroulant Request Method, vous n’en utiliserez souvent que deux : GET pour récupérer des données de l’API et POST pour lui envoyer des données.

ShortPixel fonctionne en lui envoyant d’abord une image, nous utilisons donc la méthode POST. La plupart des demandes d’API nécessitent également une méthode GET, afin que votre site puisse recevoir des données et en envoyer.

Il existe un ensemble de champs facultatifs sous les quatre principaux pour définir les délais de connexion et la mise en cache. Ensuite, en fonction de votre méthode d’authentification, vous devez saisir vos informations d’identification dans l’un des champs Query String, Headers ou Body. ShortPixel utilise une clé d’API dans la chaîne d’URL, nous pouvons donc ajouter la nôtre dans les champs Query String :

Ajout d'informations sur la clé d'accès au champ Query String dans WPGetAPI.
Ajout d’informations sur la clé d’accès au champ Query String dans WPGetAPI.

Enregistrez à nouveau vos modifications, puis regardez en haut de l’écran le bouton Test Endpoints. En cliquant sur ce bouton, vous testerez la connexion et vous obtiendrez un rapport ainsi que l’état de la connexion :

Test d'un point de terminaison dans WPGetAPI.
Test d’un point de terminaison dans WPGetAPI.

La dernière tâche pour connecter l’API à WordPress est de copier le shortcode ou le template tag en haut de l’écran :

Choisir une méthode d'affichage des informations de l'API dans WPGetAPI.
Choisir une méthode d’affichage des informations de l’API dans WPGetAPI.

Vous pouvez les coller à un endroit pertinent de votre code ou de votre page, selon ce que vous préférez.

Évaluer les performances des API tierces à l’aide de Kinsta APM

Un élément clé de l’intégration d’API tierces dans WordPress est leur performance. Il ne sert à rien d’utiliser une API si elle a un impact négatif sur votre site. C’est là que l’outil Kinsta APM entre en jeu.

L'écran Kinsta APM dans le tableau de bord MyKinsta.
L’écran Kinsta APM dans le tableau de bord MyKinsta.

Il vous permet de juger de la performance objective de votre site à travers le tableau de bord MyKinsta. Il fournit un ensemble pratique de graphiques et de mesures pour vous aider à évaluer l’efficacité de votre site :

L'outil APM de Kinsta qui rend compte des temps de transaction d'un site.
L’outil APM de Kinsta qui rend compte des temps de transaction d’un site.

Il y a beaucoup à découvrir avec l’outil APM de Kinsta, mais l’utiliser pour surveiller vos « temps de transaction » est un cas d’utilisation clé. Cela vous permet de voir quelles parties de votre site nécessitent le plus de ressources.

Bien sûr, vous voudrez examiner l’impact de toutes les requêtes et processus HTTP externes. Si votre API est gourmande en ressources, vous pouvez commencer à l’affiner pour améliorer ses performances. Le fait d’avoir ces mesures à portée de main dans le tableau de bord MyKinsta peut vous rappeler en permanence où votre site a besoin d’être amélioré.

Résumé

L’intégration d’API tierces avec WordPress sur Kinsta peut vous aider à étendre les fonctionnalités de votre site. Cela peut vous faire gagner du temps de développement, en améliorant l’interface utilisateur et en augmentant l’efficacité. Mieux encore, WordPress vous offre quelques moyens de connecter des API tierces.

Vous pouvez utiliser l’API REST de WordPress ou même une extension qui fait le gros du travail pour vous. WPGetAPI est l’un des meilleurs et utilise une approche à code bas, avec une interface conviviale. Si vous combinez cela avec l’outil Kinsta APM, vous disposez d’un moyen objectif de surveiller les performances de votre site à l’aide d’une solution de première partie.

Pensez-vous que les API tierces valent la peine d’être implémentées dans WordPress ? Faites-nous part de vos réflexions dans la section des commentaires ci-dessous !

Jeremy Holcombe Kinsta

Rédacteur en chef du contenu et du marketing chez Kinsta, développeur web WordPress et rédacteur de contenu. En dehors de WordPress, j'aime la plage, le golf et le cinéma. J'ai aussi des problèmes avec les personnes de grande taille ;).