API signifie Application Programming Interface, Interface de programmation d’application en français. L’API est une solution informatique qui permet à des applications de communiquer entre elles. Elle permet aussi de s’échanger mutuellement des services ou des données. Comment fonctionne l’API Klaviyo ?

Comment fonctionne une clé API ?

Considérez les clés API comme une carte de bibliothèque. C’est un moyen de vous identifier. Vous auriez besoin de votre carte de bibliothèque pour emprunter des livres à la bibliothèque (dans ce cas l’API). La bibliothèque a besoin de votre carte pour pouvoir suivre les livres que vous avez empruntés (qui a la permission d’accéder à l’API).

Différence entre clé API publique et privée

Votre clé API publique est également appelée votre ID de site. Il s’agit d’une courte valeur alphanumérique. Cette clé publique est un identifiant unique pour votre compte Klaviyo, et il n’y en a qu’un par compte. Il est sûr d’exposer votre clé API publique. En effet, elle ne peut pas être utilisée pour accéder aux données de votre compte Klaviyo.

Les clés API privées sont utilisées pour lire les données de Klaviyo et manipuler certains objets sensibles tels que les listes. Traitez les clés API privées comme des mots de passe. Il faut les conserver en lieu sûr et ne jamais les exposer au public. Un compte Klaviyo peut générer autant de clés API privées que nécessaire. 

Trouver votre clé API sur Klaviyo

Votre clé API se trouve sur votre compte, dans paramètres > Clés API. 

A cet endroit vous trouverez votre clé API publique et vos clés d’API privées.

Ajouter un champ d'application à une clé d'API privée

Accédez aux paramètres du compte. Ensuite cliquez sur clés API, puis créez une clé API privée. Choisissez son nom et le champ d’application que vous souhaitez lui attribuer. (lecture seul, accès complet ou personnalisé). Enfin sélectionnez créer.

Désormais, lorsque vous partagez une clé API privée. Le tiers aura accès aux informations définies dans le champ d’application.

Comment fonctionne l'API Klaviyo ?

Un appel API standard se produit en quelques secondes

Vous envoyez une demande de données sur Internet à l’API. Les requêtes sont envoyées via HTTPL’API reçoit la demande, la traite et obtient les informations demandées à partir des bases de données de Klaviyo. L’API répond ensuite à l’application du client en utilisant le format structuré JSONVous recevrez la réponse JSON de l’application du client.

Les méthodes HTTP

Les méthodes HTTP sont les « verbes » par lesquels vos requêtes sont envoyées. Il existe deux méthodes HTTP que nous aborderons dans ce guide : GET et POST.  

Une requête GET peut être plus facilement comprise comme une requête de « lecture ». Les requêtes GET récupèrent les informations du point de terminaison de l’API et vous les renvoient dans une réponse au format JSON. Ces requêtes vous permettent uniquement de lire des données, ce qui en fait le type de requête le plus sûr car vos données ne peuvent pas être modifiées ou écrasées avec cette méthode.

Une requête POST peut être simplement comprise comme une requête « écriture ». POST vous permet de créer ou d’ajouter de nouvelles ressources. Par exemple, une requête POST à l’API List peut être utilisée pour créer une nouvelle liste dans votre compte, tandis qu’une requête GET peut être utilisée pour récupérer toutes les listes disponibles.

Les API Klaviyo

Klaviyo a deux versions de l’API List. La version 2 propose une gamme d’options plus large et doit être utilisée dans la plupart des cas, et sera ci-après simplement appelée API de liste.

L’API List est utilisée pour créer des listes, gérer les adhésions aux listes et modifier les abonnements aux listes via un ensemble de points de terminaison. Avec l’API List, vous pouvez rapidement récupérer un catalogue de toutes les listes de votre compte. Vous pouvez voir les détails de listes spécifiques, créer de nouvelles listes et ajouter des membres et des abonnés à la liste.

Pas d'outils nécessaires

Les API offrent une grande flexibilité à vos flux de travail. Elles ne vous obligent pas à utiliser l’application du client ou une bibliothèque de langage spécifique pour obtenir les résultats souhaités. Comme les appels d’API sont effectués à l’aide de requêtes HTTP, presque tous les langages de programmation ont la capacité d’envoyer ce type de requête de manière native ou via une bibliothèque de langages largement disponible. 

Certaines API Klaviyo prennent en charge les méthodes intégrées au navigateur. Cela vous permet d’effectuer des requêtes à l’aide de paramètres d’URL ou depuis la console développeur de votre navigateur.

Pour aller plus loin

Pour en savoir davantage, vous pouvez consulter la documentation sur les clés API Klaviyo juste ici.