Comprendre les plates-formes basées sur des API : un guide pour les chefs de produit

Publié: 2022-03-10
Résumé rapide ↬ Les solutions basées sur des API deviennent un élément essentiel des produits numériques modernes. Que sont-ils? Comment peuvent-ils impacter votre processus de conception ? Enfin, comment les évaluer sans déranger votre équipe logicielle ?

Construire un produit numérique aujourd'hui, c'est intégrer la myriade de divers systèmes de back-office avec des points de contact et des appareils clients. Le coût d'engagement d'une équipe logicielle pour les connecter dans une solution de travail unique pourrait monter en flèche.

C'est pourquoi les chefs de produit modernes, lors du choix des fournisseurs, placent souvent les capacités d'intégration en premier lieu, ce qui peut se résumer à choisir des systèmes exposant l'API. Qu'est-ce que l'API et comment la tester sans engager votre équipe technique ? Continuer à lire.

Adoptez les données : pourquoi nous avons besoin d'API

Les données clients modifient le fonctionnement de l'entreprise. S'ils sont correctement collectés et déplacés, ils peuvent aider les entreprises à augmenter leurs taux d'acquisition et de fidélisation de la clientèle, entraînant éventuellement une augmentation des revenus.

Mais le traitement des données est un travail fastidieux. C'est pourquoi les entreprises ont puisé dans l'informatique. Dans les années 1990, les bases de données qui automatisent les tâches de données les plus chronophages sont devenues massivement populaires dans les services marketing. Cela a conduit à un changement massif dans la conception des stratégies marketing - ce changement a été appelé l' approche basée sur les données .

Les bases de données avaient cependant un inconvénient majeur. Pour en faire quelque chose de valeur, une entreprise devait embaucher des ingénieurs en logiciel. Ils étaient les héros qui savaient comment transformer d'énormes piles de données en informations de travail. Ils étaient également les gardiens de l'intégrité des données et s'assuraient ainsi que le système était à l'épreuve du temps.

Mais les ingénieurs logiciels coûtaient cher et leur interface de communication nécessitait des efforts.

Lorsque le nombre de canaux de collecte de données s'étendait sur plusieurs départements et même sur des sociétés externes, les bases de données et leurs opérateurs devenaient un goulot d'étranglement. Les entreprises devaient trouver un moyen automatisé d'accéder aux magasins de données.

C'est ainsi que l'idée des systèmes API-first est née.

Plus après saut! Continuez à lire ci-dessous ↓

Qu'est-ce que l'API est réellement sans le jargon technique

Les systèmes API-first, aujourd'hui couramment abrégés en API (Application Programmable I nterface ), sont les applications qui garantissent que d'autres systèmes peuvent accéder à leurs données de manière unifiée et sécurisée.

Sans une note en informatique, l'interface programmable d'application ne sonne pas vraiment. Voyons une explication plus tangible.

L'une des meilleures analogies que j'ai trouvées sur le Web jusqu'à présent a été écrite par Taija :

"Si vous allez dans un restaurant en tant que client, vous n'êtes pas autorisé à entrer dans la cuisine. Vous devez savoir ce qui est disponible. Pour cela, vous avez le menu. Après avoir regardé le menu, vous passez une commande à un serveur, qui la passe à la cuisine et qui vous livrera ensuite ce que vous avez demandé. Le serveur ne peut livrer que ce que la cuisine peut fournir.
Quel est le rapport avec une API ? Le serveur est l'API. Vous êtes quelqu'un qui demande du service. En d'autres termes, vous êtes un client ou un consommateur d'API. Le menu est la documentation qui explique ce que vous pouvez demander à l'API. La cuisine est, par exemple, un serveur ; une base de données qui ne contient qu'un certain type de données - tout ce que l'acheteur a acheté pour le restaurant comme ingrédients et ce que le chef a décidé d'offrir et ce que les cuisiniers savent préparer.

Donc encore:

  • Cuisine
    La base de données, aucun client autorisé à protéger l'intégrité des données.
  • Serveur
    L'API, un intermédiaire qui sait servir les données de la base de données sans perturber son fonctionnement.
  • Client
    Un système externe qui veut obtenir leurs données
  • Menu
    La référence de format de données que les systèmes externes doivent utiliser pour effectuer leur opération.
  • Commande
    Un véritable appel d'API unique.

Avec l'état actuel de la technologie, il faut toujours qu'un développeur de logiciels « passe une commande ». Mais c'est beaucoup plus rapide (lire : moins cher) car le menu, comme celui de McDonald's, est plus ou moins standardisé à travers le monde.

Alors maintenant, nous allons porter les chaussures d'un développeur de logiciels et essayer d'appeler une API exemplaire. Ne t'inquiète pas; nous n'allons pas aller au-delà des cours d'informatique à l'école.

Comment votre application météo obtient les données : principes de base de l'API

Nous allons découvrir comment votre application météo connaît la température actuelle. De cette façon, nous aurons les bases de la communication avec les systèmes via Internet.

Ce dont nous avons besoin:

  • Une base de données météo
  • Un navigateur
  • Une pointe de volonté

C'est ça! La technologie d'aujourd'hui facilite le test de l'API sans avoir besoin de gros outils de développement.

Bien sûr, c'est différent lorsque vous souhaitez créer une intégration complète. Lorsque la poussée arrive, vous devez connaître des outils et des langages de programmation plus avancés, mais pour les tests/preuves de concepts, cette configuration est suffisante.

Essayons donc d'obtenir l'indice de température actuel de votre ville - ou, dans le langage des codeurs - appelons le premier appel d'API. Après tout, cela revient à envoyer du texte à un serveur et à recevoir un message en échange .

L'anatomie d'une requête API

Dans cet article, nous utiliserons l'API https://openweathermap.org. Visitez le site et essayez de vérifier les conditions météorologiques à plusieurs endroits. J'espère que vous vous sentez mieux que moi à Katowice aujourd'hui :

Ouvrir le widget de l'API de la carte météo
Ouvrir le widget API Weather Map ( Grand aperçu )

Comme vous l'avez peut-être deviné, le site Web appelle l'API pour obtenir les données. Les développeurs l'ont implémenté de manière à ce que chaque fois que vous appuyez sur rechercher , l'application frappe en coulisses à la porte de l'API et dit "donnez-moi la température de <ville>".

Mettons un chapeau de pirate informatique et voyons les appels d'API que ce site Web appelle avec votre navigateur. Vous pouvez utiliser les outils de développement dans votre navigateur pour voir ce qui se passe dans les coulisses :

  1. Dans Chrome, accédez à Menu → Plus d'outils → Outils de développement ;
  2. Passez à l'onglet Réseau ;
  3. Essayez de vérifier la température dans différentes villes dans le widget ci-dessus ;
  4. Dans la liste en bas, vous remarquerez des liens qui ont été appelés :
    Surveillance des requêtes dans les outils de développement Chrome
    Moniteur de demandes dans Chrome Developer Tools ( Grand aperçu )

    Si vous copiez le lien, vous pouvez voir qu'il inclut le nom de l'emplacement et quelques autres paramètres.
     https://openweathermap.org/data/2.5/find?callback=jQuery19103887954878001505_1542285819413&q=Katowice&type=like&sort=population&cnt=30&appid=b6907d289e10d714a6e88b30761fae22&_=1542285819418
  5. Lorsque vous collez le lien dans la barre d'adresse du navigateur, vous devriez voir les réponses de l'API :
     jQuery19103887954878001505_1542285819413({"message":"accurate","cod":"200","count":1,"list":[{"id":3096472,"name":"Katowice","coord":{"lat":50.2599,"lon":19.0216},"main":{"temp":281.69,"pressure":1031,"humidity":61,"temp_min":281.15,"temp_max":282.15},"dt":1542285000,"wind":{"speed":3.6,"deg":50},"sys":{"country":"PL"},"rain":null,"snow":null,"clouds":{"all":90},"weather":[{"id":804,"main":"Clouds","description":"overcast clouds","icon":"04d"}]}]})
  6. C'est un peu chaotique, mais si vous supprimez le contenu des parenthèses et que vous l'exécutez avec un formateur de données, vous verrez une structure logique :
     { "message":"accurate", "cod":"200", "count":1, "list":[ { "id":3096472, "name":"Katowice", "coord":{ "lat":50.2599, "lon":19.0216 }, "main":{ "temp":281.69, "pressure":1031, "humidity":61, "temp_min":281.15, "temp_max":282.15 }, "dt":1542285000, "wind":{ "speed":3.6, "deg":50 }, "sys":{ "country":"PL" }, "rain":null, "snow":null, "clouds":{ "all":90 },
  7. La réponse de l'API est une structure de données contenant des informations sur les conditions météorologiques actuelles - vous devriez facilement décrypter la plupart des paramètres. Ce format de données s'appelle JSON . C'est une notation importante car la plupart des API modernes l'utilisent. Cette pile d'identificateurs et de parenthèses a un seul objectif : il est plus facile pour une application d'analyser un message bien structuré qu'un texte placé au hasard.

Un mot d'explication de ce que nous venons de faire ici.

L'application Web derrière le site Web Open Weather Map récupère les données de l'API et les affiche sur le site Web.

Chaque fois que vous tapez le nom de la ville et que vous appuyez sur rechercher , le site Web se connecte à un serveur avec un lien spécifique qui inclut le nom de la ville en paramètre.

La même phrase dans le jargon technique : l'application derrière le site Web envoie une requête à un point de terminaison API en fournissant le nom de la ville comme argument .

Ensuite, l'API répond (envoie une réponse API ) avec un message texte au format JSON .

Webapp - Diagramme de la base de données
Webapp <—> Diagramme de base de données ( Grand aperçu )

Pour créer une requête API, vous devez rassembler son adresse. Ouais, l'adresse est une bonne analogie. Pour expédier quelque chose, vous devez fournir au transporteur :

  • Ville,
  • Rue et numéro,
  • Parfois, quelques informations supplémentaires sur la façon de se rendre à votre bureau.

Et, pour se connecter à l'API, par analogie, il faut :

  • https://openweathermap.org/ (lien) La ville ou le point de terminaison racine - un point de départ, une adresse Internet d'un serveur auquel vous souhaitez vous connecter, dans notre cas.
  • data/2.5/find (lien) Le numéro de rue ou le chemin — détermine la ressource que vous souhaitez obtenir à partir d'une API.
  • ?callback=jQuery19103887954878001505 1542285819413&q=Katowice&type=like&sort=population&cnt=30&appid=b6907d289e10d714a6e88b30761fae22& =1542285819418 (lien)

C'est ainsi que les API sont conçues. Le point de terminaison racine reste généralement le même pour un seul fournisseur, vous devez ensuite déterminer quels paramètres de chemin et de requête sont disponibles et quelles informations l'équipe de développement d'API a mises derrière eux.

Maintenant, resserrons un peu le chapeau du hacker. Dans notre cas, tous les paramètres de requête ne sont pas nécessaires pour obtenir les données météorologiques. Essayez de supprimer différents paramètres après le point d'interrogation ( ? ) et vérifiez la réponse de l'API Météo.

Par exemple, vous pouvez commencer par supprimer le callback du lien de demande :

 https://openweathermap.org/data/2.5/find?callback=jQuery19103887954878001505_1542285819413&q=Katowice&type=like&sort=population&cnt=30&appid=b6907d289e10d714a6e88b30761fae22&_=1542285819418

Le résultat:

 https://openweathermap.org/data/2.5/find?q=Katowice&type=like&sort=population&cnt=30&appid=b6907d289e10d714a6e88b30761fae22&_=1542285819418

Si vous jouez avec les autres, vous pouvez voir que certains d'entre eux sont également facultatifs. En fait, seuls q et appid sont obligatoires :

 https://openweathermap.org/data/2.5/find?q=Katowice&appid=b6907d289e10d714a6e88b30761fae22

Comment savoir ce qui est obligatoire et ce qui est facultatif ? Comment savez-vous où obtenir le point de terminaison racine et le chemin en premier lieu ?

Documentation de l'API : à lire absolument avant de commencer

Vous devez toujours consulter d'abord la documentation de l'API pour savoir comment construire votre requête de la bonne manière.

Dans notre cas, la documentation https://openweathermap.org/current montre les endpoints disponibles. Il explique également tous les champs de données de réponse - afin que vous puissiez trouver les informations auxquelles l'API répondra avant même d'envoyer une demande.

Une bonne documentation API propose des tutoriels de démarrage rapide sur la façon de créer des requêtes simples et de passer à des choses plus avancées. Heureusement, l'API Open Weather en a une et nous allons l'utiliser maintenant.

Créer un appel API à partir de rien

Résumons nos découvertes. Nous avons déjà envoyé une demande à l'API. Nous avons trouvé le bon lien en reniflant ce que fait OpenWeatherMap dans les coulisses. Cette approche s'appelle la rétro-ingénierie et c'est souvent difficile ou pas possible du tout.

De plus, la plupart du temps, les fournisseurs d'API interdisent aux utilisateurs de trop utiliser cette option. C'est pourquoi nous devons apprendre à "appeler" l'API par les règles (c'est-à-dire la documentation).

Une façon de le faire est de le coder. Mais comme nous ne sommes pas ( encore! ) codeurs, nous allons utiliser des outils qui facilitent cela. Tellement plus facile que même les développeurs de logiciels l'ont sous leur ceinture à outils.

Comme promis, nous ne quitterons pas le navigateur. Mais nous devons installer une extension (Chrome uniquement) - Postman. Ce plugin simple transforme votre navigateur en un connecteur API.

Vue principale du facteur
Vue principale du facteur ( Grand aperçu )

OK, maintenant que nous avons un outil, examinons la documentation pour voir comment nous pouvons obtenir les conditions météorologiques actuelles pour un nom de ville spécifique https://openweathermap.org/current#name .

La documentation indique que nous devrions utiliser le point de terminaison suivant : api.openweathermap.org/data/2.5/weather?q={city name}

Lorsque nous le décomposons, nous obtenons les éléments suivants :

  • Point de terminaison racine : api.openweathermap.org
  • Chemin : data/2.5/weather
  • Paramètre de requête : q={city name} (cette notion signifie que nous devons remplacer les accolades par un nom de ville spécifique)

Mettons-le dans Postman. Le processus se résume en trois étapes faciles :

  1. Cliquez sur 'Demande' dans le menu du haut.
    Postman nouvelle vue de la demande
    Postman nouvelle vue de demande ( Grand aperçu )
  2. Nommez votre demande et indiquez également le nom du catalogue dans la section en bas.
    Afficher le nom de la demande du facteur
    Vue du nom de la demande du facteur ( Grand aperçu )
  3. Collez le point de terminaison de l'API que vous souhaitez appeler, cliquez sur Envoyer et vous devriez voir la réponse de l'API dans la section Réponse :
    Envoi de la première demande avec Postman
    Envoi de la première demande avec Postman ( Grand aperçu )

Félicitations! Vous venez d'appeler votre sapin avec succès… attendez une seconde ! Faisons attention à la réponse de l'API :

Exemple de réponse invalide
Exemple de réponse invalide ( Grand aperçu )

Ce n'est pas un JSON rempli d'informations météorologiques que nous avons déjà vues. Que signifient le 401 et la clé API invalide ? Notre documentation est-elle erronée ?

Authentification

Vous ne laisseriez personne accéder à votre armoire à cocktails sans votre permission, n'est-ce pas ? De la même manière, les fournisseurs d'API souhaitent également contrôler les utilisateurs de leur produit pour le protéger des activités malveillantes. Qu'est-ce qu'une activité malveillante ? Par exemple, envoyer de nombreuses requêtes API en même temps, ce qui « surchauffera » le serveur et entraînera des temps d'arrêt pour les autres utilisateurs.

Comment contrôler l'accès ? De la même manière que vous gardez vos boissons ! En utilisant des clés — clés API .

Si vous visitez le guide de démarrage de la documentation de l'API météo, vous remarquerez comment vous pouvez obtenir votre clé. Inscrivez-vous maintenant et vérifiez votre boîte de réception.

Alors maintenant, la question est de savoir comment utiliser la clé? C'est facile, selon la documentation, il suffit de copier et coller la clé à la fin de l'URL de votre point de terminaison (sans accolades).

 api.openweathermap.org/data/2.5/weather?q=Katowice&appid={your API key}

Et cliquez à nouveau sur envoyer. Et voilà, nous pouvons maintenant voir la réponse de l'API !

Réponse réussie de l'API Open Weather Map
Réponse réussie de l'API Open Weather Map ( Grand aperçu )

Mais il y a beaucoup plus que vous pouvez obtenir de l'API en utilisant Postman. Prêt à devenir un véritable hacker d'API ?

Paramètres de l'API : obtenir des réponses personnalisées

Habituellement, les points de terminaison d'API ont des fonctionnalités utilitaires que vous pouvez utiliser pour ajuster la réponse de l'API, par exemple si vous avez besoin d'un meilleur format de données ou si vous souhaitez obtenir les données dans un ordre particulier. Ces options sont souvent cachées derrière certains paramètres que vous pouvez trouver dans la documentation.

Les paramètres de requête ne sont qu'un texte structuré que vous ajoutez à l'adresse du point de terminaison avec le modèle suivant :

  1. Un point d'interrogation ( ? ) après le chemin,
  2. Nom d'un paramètre,
  3. Symbole égal à ( = ),
  4. Valeur du paramètre,
  5. L'esperluette ( & ) et d'autres suivent avec les points 2-4 (de cette façon, vous pouvez ajouter autant de paramètres que vous le souhaitez).

Prenons notre première requête comme exemple :

 https://openweathermap.org/data/2.5/find?q=Katowice&appid=b6907d289e10d714a6e88b30761fae22

Remarque importante : l'ordre des paramètres de requête n'a pas d'importance.

 ?q=Katowice&appid=b6907d289e10d714a6e88b30761fae22

Ce qui précède est le même que ce qui suit :

 ?appid=b6907d289e10d714a6e88b30761fae22&q=Katowice

Comme mentionné, les paramètres de requête sont décrits dans la documentation de l'API. L'extrait suivant de la documentation de l'API météo vous montre comment obtenir la température dans différentes unités (impériales ou métriques) :

Extrait de la documentation de l'API OpenWeatherMap
Extrait de documentation de l'API OpenWeatherMap ( Grand aperçu )

Essayez d'envoyer ces deux options avec Postman pour voir la différence de résultats. N'oubliez pas d'ajouter votre clé API à la fin de l'adresse du point de terminaison.

Note : Prenez toujours le temps d'étudier la documentation et de trouver les paramètres qui peuvent vous faire gagner du temps, à vous ou à votre équipe de développement.

Options de demande d'API : comment envoyer des données à l'API

Jusqu'à présent, nous avons obtenu des informations de l'API. Et si nous voulons ajouter ou modifier des informations dans la base de données derrière l'API ? Les méthodes de requête sont la réponse.

Jetons un coup d'œil à Postman une fois de plus. Vous avez peut-être remarqué une étiquette GET en majuscules à côté de l'adresse du point de terminaison de l'API. Cela représente l'une des quatre méthodes de demande. GET signifie que nous voulons obtenir quelque chose de l'API (merci capitaine) et c'est une option par défaut. Quelles sont les autres options ?

Nom de la méthode Ce qu'il fait avec l'API
GET L'API recherche les données que vous avez demandées et vous les renvoie.
POST L'API crée une nouvelle entrée dans la base de données et vous indique si la création a réussi.
PUT L'API met à jour une entrée dans la base de données et vous indique si la mise à jour a réussi.
DELETE L'API supprime une entrée dans la base de données et vous indique si la suppression a réussi.

Toujours déroutant ? Passons aux exemples.

API POST : comment créer un enregistrement dans l'API

Nous ne pouvons rien créer ni mettre à jour avec l'API Météo (car elle est censée être en lecture seule), nous devons donc en trouver une autre à des fins de test.

Prenons un exemple plus axé sur les affaires. Nous allons simuler le scénario suivant :

S'il pleut, créez un bon de réduction « égayez-vous » pour vos clients.

Nous allons utiliser Voucherify qui fournit une API pour créer et suivre des promotions pour n'importe quel système de commerce électronique.

Disclaimer : Je suis co-fondateur de Voucherify. Je suis heureux de répondre à vos questions sur la conception et la mise en œuvre de promotions numériques, et sur notre API bien sûr .

Nous savons déjà comment les obtenir à partir de l'exemple précédent, alors concentrons-nous sur la création d'un coupon :

  1. Comme nous l'avons dit, nous devrions toujours commencer par la documentation.
  2. Le guide de démarrage rapide nous dit d'obtenir notre clé API.
    Remarque : Au lieu de créer un compte, vous pouvez utiliser les clés de test du guide de démarrage rapide — nous vous montrerons comment dans une minute.
  3. Voyons maintenant comment créer un bon de réduction. Dans Voucherify, ce type de promotion est représenté par un « bon ».
  4. À partir de la documentation, vous apprendrez que pour créer un bon, vous devez appeler une méthode POST au point de terminaison /vouchers .
  5. Créez une nouvelle demande dans Postman.
  6. Remplacez la méthode par POST.
    Postman - Sélection des méthodes API
    Postman - Sélection des méthodes API ( Grand aperçu )
  7. Collez le point de terminaison Voucherify https://api.voucherify.io/v1/vouchers/ et cliquez sur Envoyer.
    Identifiants manquants
    Identifiants manquants ( Grand aperçu )
  8. Oh snap, nous ne sommes pas autorisés à appeler ce point de terminaison. Comme vous l'avez peut-être deviné, nous devons fournir des clés API.

    Voucherify a une manière légèrement différente de le faire. Au lieu de les mettre en tant que paramètres de requête, vous devez les mettre dans les en-têtes. Il s'agit d'une approche courante car il est plus facile d'implémenter et de maintenir les clés de cette manière plutôt que de les ajouter en tant que paramètres de requête.

    Ajoutez les clés comme dans l'image et cliquez sur Envoyer. Notez que Voucherify nécessite deux clés. Voici ceux que vous pouvez utiliser dans le cadre de ce tutoriel :
    X-App-Id: 8a824b12-0530-4ef4-9479-d9e9b9930176 X-App-Token: 9e322bac-8297-49f7-94c8-07946724bcbc
    Fournir des clés API dans Postman
    Fournir des clés API dans Postman ( Grand aperçu )
  9. Nous recevons un autre message d'erreur, cette fois il dit que la charge utile ne peut pas être vide.
    L'API Voucherify renvoie le code d'erreur 400
    L'API Voucherify renvoie le code d'erreur 400 ( Grand aperçu )

    Qu'est-ce que c'est qu'une charge utile ? Comme dans le cas de GET, nous voulons récupérer des informations, avec POST, nous devons envoyer quelque chose et le message que nous envoyons s'appelle la charge utile et c'est généralement un fichier JSON.

    Maintenant, l'API Voucherify se plaint que nous n'en avons pas fourni, ce qui signifie qu'elle ne peut pas créer de bon car nous n'avons pas indiqué le type de bon qu'elle devrait créer. Et maintenant ? Retour aux docs !
  10. Découvrons le type d'informations dont cette requête a besoin pour réussir. Nous pouvons voir beaucoup d'options sur la liste.
    Extrait de la documentation de l'API Voucherify
    Extrait de la documentation de l'API Voucherify ( Grand aperçu )

    Un paramètre (type) est obligatoire et un autre facultatif. Disons qu'il s'agira d'une remise de 20 %, disponible pour les 100 premiers clients, qui expire aujourd'hui. Nous devons maintenant trouver les paramètres responsables de ces fonctionnalités de remise et les rassembler dans un format compréhensible pour l'API Voucherify. Comme vous pouvez le voir dans les exemples ci-dessus, la notation JSON que vous devez utiliser ressemble à ceci :
     { "type":"DISCOUNT_VOUCHER", "discount":{ "percent_off":20.0, "type":"PERCENT" }, "expiration_date":"2018-12-03T23:59:59Z", "redemption":{ "quantity":100 }
  11. Pour configurer la charge utile dans Postman, collez le message JSON dans l'onglet Corps. Sélectionnez le type "raw" et JSON dans la liste des formats de charge utile disponibles et confirmez avec Envoyer.
    Méthode POST dans Postman
    Méthode POST dans Postman ( Grand aperçu )
  12. Voila ! Voucherify a créé avec succès notre coupon de réduction de 20 % (comme nous travaillons avec un compte de test, tous les codes générés commencent par le préfixe "voucherify.io-"). L'équipe marketing peut désormais partager le code avec les clients et Voucherify le validera automatiquement chaque fois qu'ils se rendront dans votre boutique pour l'utiliser.
    Bon de réduction renvoie 200 OK
    Voucherify renvoie 200 OK ( Grand aperçu )

    Mais comment savons-nous qu'il s'agit d'une demande réussie ? Tout d'abord, nous pouvons voir que Voucherify nous a envoyé un message qui, selon leurs documents, ressemble à une réponse API correcte. Deuxièmement, Postman affiche le statut 200 OK - ce qui signifie que notre demande a réussi. Pourquoi 200 et quel est le statut ?

Codes d'état de l'API et messages d'erreur

La plupart des API avec lesquelles vous interagirez seront basées sur HTTP. Le HTTP est un protocole qui normalise la communication entre différentes applications clientes et serveurs sur Internet.

L'un des éléments clés de HTTP est les codes d'état. En comprenant le code d'état, vous (ou les systèmes que vous implémentez) pouvez immédiatement dire ce qui est arrivé à votre demande. Il y a de fortes chances que vous ayez rencontré l'un des codes de statut les plus populaires lorsque vous avez tapé le mauvais lien - 404

Bon d'achat code d'erreur 404
Bon d'achat 404 code d'erreur ( Grand aperçu )

Mais il y en a beaucoup plus et les utilisateurs finaux ne les voient généralement pas. Ils vont de 100+ à 500+. En général, les nombres suivent les règles suivantes :

  • 200+ signifie que la demande a réussi ;
  • 300+ signifie que la requête est redirigée vers une autre URL ;
  • 400+ signifie qu'une erreur provenant de l'application cliente s'est produite ;
  • 500+ signifie qu'une erreur provenant du serveur s'est produite.

Si vous pouviez répéter les étapes, vous verriez que Voucherify a répondu avec 401 Unauthorized lorsque nous n'avons pas fourni de clés API. Ou 400 Bad Request lorsqu'il n'y avait pas de charge utile requise pour la demande de création de bon. Enfin, nous avons reçu 200 comme jeton d'un appel API réussi.

Si vous êtes curieux de connaître la signification des codes d'état HTTP, il n'y a pas de meilleur endroit que HTTP Cats (ou cet article peut-être).

Chats HTTP 401 non autorisés
Chats HTTP 401 ( Grand aperçu )

Sommaire

La quantité croissante de données et le besoin de rapidité dans la création de produits ont poussé les API à devenir la lingua franca des équipes numériques. Pour concevoir des systèmes basés sur des systèmes API-first, assurez-vous de bien comprendre les offres des fournisseurs. Ce guide de test pratique est un bon point de départ pour le faire. Cela vous aidera à explorer les capacités de l'API avant même de la lancer à votre équipe d'enseignants, économisant ainsi leur énergie - et la vôtre également.

Lectures complémentaires

  • "Une introduction aux API de commerce électronique pour les non-développeurs", Scott Brinker
  • "Allez au-delà du CMS sans tête - Rencontrez le commerce sans tête", Michal Sedzielewski, Voucherify
  • "Comment utiliser les plates-formes API-First pour créer vos sites Web plus rapidement", Michal Sedzielewski, Medium
  • "Comment utiliser votre plate-forme API-First pour préparer votre prototype pour la production", Michal Sedzielewski, Medium
  • "Comment utiliser le cloud pour créer des applications plus rapidement", Michal Sedzielewski, Hacker Noon