8 min de lecture

J’ avais l’habitude de travailler dans le service client dans une société de technologie où les connexions API qui extraient les données utilisateur d’autres programmes faisaient partie intégrante du produit. Lorsque j’expliquais aux clients pourquoi nous ne pouvions pas accéder à un élément de données particulier, les développeurs recommandaient souvent la réponse : « Ce n’est pas disponible via l’API ».

À l’époque, je me suis dit qu’une API était comme un port USB, et en se connectant à ce port, nous aurions accès à tout dans un autre programme. Il s’avère que j’avais tort.

Lire aussi : Zapier vs IFTTT : le meilleur outil pour l’automatisation des tâches

Les API sont moins comme les ports USB ou les tuyaux d’incendie qu’elles ne sont comme une personne dans un centre d’assistance dans un pays étranger. Une API ne vous donnera pas toutes les informations ou le code d’un programme (comme un tuyau d’incendie), car qu’est-ce qui vous empêcherait de répliquer toute la base de code ? Au lieu de cela, une API vous fournit des données que ses programmeurs ont mises à la disposition des utilisateurs externes. Même ainsi, vous devez connaître leet poser les bonnes questions afin de faire quoi que ce soit avec ces données.

Qu’ est-ce qu’une API ?

API signifie interface de programmation d’application. La partie la plus importante de ce nom est « interface », car une API parle essentiellement à un programme pour vous. Vous devez toujours connaître la langue pour communiquer avec le programme, mais sans API, vous n’irez pas loin.

Lorsque les programmeurs décident de rendre certaines de leurs données accessibles au public, ils « exposent les points de terminaison », ce qui signifie qu’ils publient une partie du langage qu’ils ont utilisé pour créer leur programme. D’autres programmeurs peuvent ensuite extraire des données de l’application en créant des URL ou en utilisant des clients HTTP (programmes spéciaux qui créent les URL pour vous) pour demander des données à partir de ces points de terminaison.

Les points de terminaison renvoient du texte destiné aux ordinateurs à lire, de sorte que cela n’aura pas de sens si vous ne comprenez pas le code informatique utilisé pour l’écrire.

TL ; DR : Une API permet à un programme de demanderdonnées d’un autre.

Pourquoi utiliser une API

Les ordinateurs facilitent beaucoup de choses, en particulier les tâches qui impliquent la collecte et le tri à travers des tonnes de données. Supposons que vous vouliez savoir combien de fois un tiers a soumis des factures à votre entreprise. Il est possible d’entrer dans les registres de factures de votre entreprise, de numériser l’entrée de données « de » et d’imprimer chaque facture individuellement pour votre audit.

D’ un autre côté, si toutes les factures ont été téléchargées dans une base de données centrale, vous pouvez écrire un programme simple qui accède à cette base de données et trouve toutes les instances du nom du partenaire. Cela prendrait beaucoup moins de temps et serait beaucoup plus précis.

Architecture d’une API

Les API se composent de trois parties :

  • Utilisateur : la personne qui fait une demande
  • Client : ordinateur qui envoie la demande au serveur
  • Serveur :l’ordinateur qui répond à la demande

Quelqu’ un construira le serveur en premier, car il acquiert et détient des données. Une fois ce serveur exécuté, les programmeurs publient de la documentation, y compris les points de terminaison où des données spécifiques peuvent être trouvées. Cette documentation indique aux programmeurs externes la structure des données sur le serveur. Un utilisateur externe peut alors interroger (ou rechercher) les données sur le serveur, ou créer un programme qui exécute des recherches sur la base de données et transforme ces informations dans un format différent et utilisable.

C’ est super déroutant, alors prenons un exemple réel : un carnet d’adresses.

À l’époque analogique, vous recevrez une copie de l’annuaire téléphonique des Pages blanches, qui énumérait toutes les personnes de votre ville par nom et adresse, par ordre alphabétique. Si vous avez besoin de l’adresse d’un ami, vous pouvez les rechercher par nom de famille, trouver l’adresse, puis chercher leur rue sur les cartes incluses au verso. Il s’agissait d’une quantité limitée d’informations, et il a fallu beaucoup de temps pouraccès. Maintenant, grâce à la magie de la technologie, toutes ces informations peuvent être trouvées dans une base de données.

Construisons une base de données contenant les pages blanches pour une ville fictive appelée Happyville. Les gens de HappyVille_WP ont décidé que lors de la construction de leur base de données, ils créeraient quelques catégories d’informations avec des données imbriquées en dessous. Ce sont nos points de terminaison, et ils incluront toutes les informations que l’API publiera à un programme externe.

Voici les points de terminaison répertoriés dans la documentation de HappyVille_WP :

  • /noms
    • /first_name, /last_name
  • /adresses
    • /street_address, /email_address/
  • /téléphones
    • /home_phone, /mobile_phone

Évidemment, ce ne sont pas toutes les informations qui peuvent être recueillies sur une personne. Même si HappyVille_WP recueillait des informations plus privées sur les résidents de Happyville (comme les dates de naissance et les numéros de sécurité sociale), ces données ne seraient pasêtre disponible pour les programmeurs externes sans connaître la langue de ces points de terminaison.

Ces points de terminaison vous indiquent la langue que vous devez utiliser pour demander des informations à partir de la base de données. Si vous voulez une liste de tous les gens de Happyville avec le nom de famille Smith, vous pouvez faire l’une des deux choses suivantes :

  1. Faites une demande d’URL dans un navigateur pour cette information. Cela utilise votre navigateur Internet comme client, et vous obtiendrez un document texte en langage de codage pour trier . Cette URL pourrait ressembler à ceci : http://api.happyville_wp.com/names?last_name=smith
  2. Utilisez un programme qui demande les informations et les traduit dans une forme utilisable. Vous pouvez coder votre propre programme ou utiliser un client HTTP prêt à l’emploi.

La première option est idéale pour faire des requêtes simples avec seulement quelques réponses (toutes les personnes dans un Happyville avec le nom de famille Xarlax, par exemple — je suisassez sûr qu’il n’y a que six ménages avec ce nom à Happyville). La deuxième option nécessite plus de fluidité de codage, mais est idéale pour les programmeurs qui veulent utiliser la base de données d’un autre programme pour améliorer leurs propres applications.

De nombreuses entreprises utilisent les API ouvertes de grandes entreprises comme Google et Facebook pour accéder à des données qui pourraient ne pas être disponibles autrement. Dans ce cas, les API réduisent considérablement les obstacles à l’entrée pour les petites entreprises qui, autrement, auraient à compiler leurs propres données.

Actions que vous pouvez prendre via une API

Ouah ! Ok, donc une API est la façon dont deux ordinateurs parlent l’un à l’autre. Le serveur possède les données et définit la langue, tandis que le client utilise cette langue pour demander des informations au serveur (pour info, les serveurs n’envoient pas de données sans qu’un client demande des données, mais les développeurs ont trouvé des moyens de contourner cela avec des webhooks). Les API peuvent tout faire !

Pas si vite. Le langage et la syntaxe des API limite sévèrement leurcapacités. Il existe quatre types d’actions qu’une API peut effectuer :

  • GET : demande des données à partir d’un serveur — peut être un état ou des spécificités (comme last_name)
  • POST : envoie les modifications du client au serveur ; pensez à cela comme ajouter des informations au serveur, comme faire une nouvelle entrée
  • PUT : révise ou ajoute des informations existantes
  • DELETE : supprime les informations existantes

Lorsque vous combinez les points de terminaison avec ces actions, vous pouvez rechercher ou mettre à jour toutes les informations disponibles via une API. Vous devrez vérifier la documentation de l’API pour savoir comment coder ces actions, car elles sont toutes différentes.

Pendant que nous parlons de langage et de syntaxe, nous allons couvrir les façons dont vous pouvez faire une demande sur un serveur :

HTTP : protocole de transfert hypertexte.C’est ainsi que vous êtes arrivé à notre site en premier lieu, en tapant une URL dans la barre de recherche de votre navigateur. C’est un moyen vraiment facile d’accéder aux données, mais il ne vous reviendra pas dans un joli format si vous demandez beaucoup d’informations. Nous irons plus loin dans une seconde.

Formats de texte : XML, JSON. Ce sont les principales langues pour accéder aux données via une API. Lorsque vous recevez vos données, vous devrez parcourir le code XML ou JSON pour comprendre ce que le serveur vous a donné.

Commencer à utiliser une API

La plupart des utilisations de l’API que vous verrez dans votre vie professionnelle quotidienne déplacent des informations d’un programme vers des champs de formulaire similaires dans un autre programme. Ceci est particulièrement utile lorsque vous essayez de partager des informations que vous auriez autrement à saisir à plusieurs reprises — par exemple, le partage de prospects entre votre plateforme d’automatisation marketing et votre CRM.

Les utilisations et les exemples que nous allons énumérer ici sont beaucoup plus basiques et tirer beaucoup moinsque ce que votre API standard est bon. Mais ils vous donneront une bonne idée des étapes du processus API.

  1. La plupart des API nécessitent une clé API. Une fois que vous avez trouvé une API avec laquelle vous voulez jouer, consultez la documentation pour connaître les conditions d’accès. La plupart des API vous demanderont de procéder à une vérification d’identité, comme vous connecter avec votre compte Google. Vous obtiendrez une chaîne unique de lettres et de chiffres à utiliser lors de l’accès à l’API, au lieu d’ajouter simplement votre e-mail et votre mot de passe à chaque fois (ce qui n’est pas très sécurisé – pour plus d’informations sur les autorisations et les vérifications, lisez ceci).
  2. La façon la plus simple de commencer à utiliser une API est de trouver un client HTTP en ligne, comme REST-Client, Postman ou Paw. Ces outils prêts à l’emploi (et souvent gratuits) vous aident à structurer vos demandes d’accès aux API existantes avec la clé API que vous avez reçue. Vous aurez toujours besoin de connaître une partie de la syntaxe de la documentation, mais il y a très peuConnaissances de codage requises.
  3. La meilleure façon d’extraire des données à partir d’une API consiste à créer une URL à partir de la documentation existante de l’API. Cette vidéo YouTube explique comment extraire les données de localisation de Google Maps via l’API, puis utiliser ces coordonnées pour trouver les photos à proximité sur Instagram.

Dans l’ensemble, une requête d’API ne semble pas très différente d’une URL normale du navigateur, mais les données retournées seront sous une forme facile à lire pour les ordinateurs. Voici ce qui s’est passé lorsque j’ai demandé des informations à partir de la base de données OpenWeather dans mon navigateur Web :

Exemple d’URL de la documentation — demande la météo pour une ville particulière :

api.openweathermap.org/data/2.5/weather ? q= {nom de la ville}

Tapez dans votre navigateur :

api.openweathermap.org/data/2.5/ weather?q=Nashville, TN&APIID= {numberslettersnumbersletters}

Conclusions et lectures complémentaires

Une API est utile pourextraire des informations spécifiques d’un autre programme. Si vous savez lire la documentation et écrire les requêtes, vous pouvez récupérer beaucoup de bonnes données, mais il peut être écrasant d’analyser tout cela. C’est là que les développeurs entrent en jeu. Ils peuvent créer des programmes qui affichent des données directement dans une application ou une fenêtre de navigateur dans un format facilement consommable.

Cet article gratte à peine l’iceberg qu’est la technologie API. J’ai fait des recherches sur le web un peu pour en apprendre davantage sur les API. Voici les articles et vidéos qui m’ont le plus aidé :

  • Utilisation des API : pas tout à fait aussi dur que ça en a l’air
  • Comment utiliser des API avec JavaScript
  • API Web pour les non-programmeurs
  • Cours Zapier API
  • Concepts et exemples de l’API REST
  • Quelles sont les API et pourquoi elles sont importantes

Vous souhaitez connecter vos programmes, mais n’avez pas le temps de créer un client ? Il y a beaucoup d’entreprises qui connecteront des API existantes ou construiront des connexions personnalisées pour vous. Ceux-làpeuvent aller des applications simples déclenchées par des données comme Zapier aux intégrations de Business Intelligence à grande échelle qui tirent d’énormes quantités de données provenant de plusieurs sources pour l’analyse. Savoir comment fonctionne une API est la première étape pour construire de grandes intégrations.

Lire la suite sur blog-introduction.fr