Démarrer avec les API Klaviyo
Objectif de cet article
Acquérez une compréhension fondamentale des appels d’API et de la manière dont les API Klaviyo peuvent bénéficier à votre entreprise. Dans ce guide, vous découvrirez les API REST, les méthodes HTTP et les outils de développement afin de vous préparer à tester les API de Klaviyo. Vos premiers appels d’API peuvent être réalisés en seulement 10 minutes, du début à la fin. Si vous connaissez déjà les appels d’API et que vous êtes prêt à tester nos API, suivez notre guide expliquant comment utiliser nos collections Postman.
Tout au long de ce guide, nous renverrons à un glossaire lorsque de nouveaux termes techniques seront introduits. Si, à un moment donné du guide, vous n’êtes pas sûr de la signification d’un mot, consultez le glossaire des termes techniques.
Qu’est-ce qu’une API REST ?
REST API est un ensemble d’acronymes qui signifient « Representational State Transfer » et « Application Programming Interface ». Ces termes peuvent être plus simplement compris comme des requêtes structurées qui permettent à un logiciel de communiquer avec un autre et de transmettre des informations entre eux. Lorsque vous effectuez un appel à l’API Klaviyo, vous envoyez une requête à un serveur et recevez une réponse. La réponse inclut un code d’état et, lorsque les points de terminaison renvoient des données, un corps au format JSON (JavaScript Object Notation). Certaines requêtes réussies ne renvoient aucun corps de réponse.
Plus simplement, les API REST vous permettent de demander des données stockées dans Klaviyo et de recevoir ces données dans un format lisible par vous et par les ordinateurs.
Une requête GET pour récupérer des données suit ces étapes :
- Envoyez une requête de données structurée via Internet vers l’API. Les requêtes sont envoyées via HTTP, un type de requête réseau de base sur lequel Internet repose en grande partie.
- L’API recevra la demande, la traitera et obtiendra les informations demandées à partir des bases de données de Klaviyo.
- L’API répond ensuite à l’application cliente au format structuré JSON.
- Vous recevrez la réponse JSON de votre application cliente.
Même si ces connaissances sont utiles pour comprendre le fonctionnement du transfert de données, elles ne sont pas nécessaires pour commencer à effectuer des appels d’API et tirer parti de ce que les API de Klaviyo ont à offrir. Les sections suivantes expliquent les bases, et le guide Postman associé vous accompagne lors de votre premier appel d’API.
Méthodes HTTP
Les méthodes HTTP sont les « verbes » qui permettent d’envoyer vos requêtes. Dans ce guide, nous aborderons 2 méthodes HTTP : GET et POST.
Bien que nous ne les utilisions pas ici, il convient de noter que la plupart des API REST prennent en charge des méthodes HTTP supplémentaires telles que PUT, PATCH et DELETE.
GET
Une requête GET peut être comprise plus facilement comme une requête de « lecture ». Les requêtes GET récupèrent des informations à partir du points 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 ni écrasées avec cette méthode.
POST
Une requête POST peut être comprise simplement comme une requête « d’écriture ». POST vous permet de créer ou d’ajouter de nouvelles ressources. Par exemple, une requête POST adressée à l’API Lists peut être utilisée pour créer une nouvelle liste dans votre compte, tandis que des requêtes GET peuvent récupérer vos listes page par page. Suivez le lien vers la page suivante dans chaque réponse jusqu’à ce qu’il n’y ait plus de pages.
Consultez la documentation de référence des points de terminaison pour connaître sa réponse en cas de réussite. La création d’une liste renvoie 201 (Created) avec les données de la nouvelle liste. Certaines requêtes POST, telles que la création d’un évènement, renvoient 202 (Accepted) sans corps de réponse. Une réponse 202 signifie que la requête a été acceptée pour traitement. Cela ne confirme pas que le traitement est terminé.
Outils nécessaires
Les API offrent une grande flexibilité à vos workflow et ne vous obligent pas à utiliser une application cliente spécifique ni une bibliothèque de langage pour obtenir les résultats souhaités. Comme les appels d’API sont effectués via des requêtes HTTP, presque tous les langages de programmation permettent d’envoyer ce type de requête de manière native ou via une bibliothèque de langage largement disponible. De plus, selon votre machine et votre système d’exploitation, vous pouvez utiliser des applications natives comme Terminal d’Apple ou Terminal de Windows pour effectuer des appels d’API depuis votre ordinateur. Cependant, ces applications nécessitent une connaissance préalable des interfaces de ligne de commande.
Nous utilisons une application web et de bureau gratuite appelée Postman. Postman dispose d’un ensemble de fonctionnalités qui facilitent la configuration et l’envoi d’une requête API en saisissant le point de terminaison, les paramètres et l’ authentification dans une interface utilisateur pratique.
Tester les API de Klaviyo
Utilisez un compte de test Klaviyo pour réaliser des essais. Les requêtes POST peuvent modifier des données dans le compte associé à vos identifiants, même lorsque vous les envoyez depuis Postman.
Pour les requêtes qui utilisent une clé d’API privée, créez une clé avec les autorisations requises par les points de terminaison que vous prévoyez de tester. Par exemple, la récupération de listes nécessite lists:read, tandis que la création d’une liste nécessite lists:write. Gardez les clés d’API privées en sécurité, et ne les exposez jamais dans le code du navigateur.
Les API de Klaviyo sont utiles pour envoyer des données provenant d’autres plateformes ou serveurs vers des comptes Klaviyo, ou pour interroger des informations au sein d’un compte Klaviyo. Maintenant que vous comprenez comment fonctionnent les API, vous pouvez commencer à tester nos API pour les cas d’usage de votre entreprise. Pour obtenir une liste complète des API disponibles de Klaviyo, consultez notre documentation de référence des API. Suivez notre guide sur l’utilisation de nos collections Postman pour effectuer votre premier appel API Klaviyo.
Ressources supplémentaires
Ressources du portail de développement
Le portail de développement de Klaviyo contient des guides d’API et une documentation de référence pour vous aider à tirer le meilleur parti de nos API. Consultez les ressources ci-dessous pour vous lancer :
- Documentation de référence des API Klaviyo
- Démarrer avec l’API JavaScript
- Configurer des événements transactionnels basés sur l’API
Formations Klaviyo Developers
Académie Klaviyo propose des formations pour les développeurs afin de vous aider à démarrer la création avec les API Klaviyo. Découvrez les formations ci-dessous :