Comment créer ou cloner une clé d'API privée ?

Vous apprendrez

Apprenez à créer une clé d'API privée, qui est un identifiant unique utilisé pour les appels à API, et à définir un champ d'application. 

La clé privéeAPI et les champs d'application vous aident à protéger vos données et celles de vos clients en limitant l'accès des tiers.

À propos de la clé d'or privéeAPI et des lunettes de visée

Lorsque vous faites un appel API, cela permet à un logiciel de se connecter à un autre. Cette connexion permet à un logiciel de demander, de modifier ou d'ajouter des informations à l'autre.  

Une clé d'API privée s'assure que cette demande dispose des autorisations nécessaires (c'est-à-dire qu'elle émane d'un utilisateur, d'un compte ou d'un programme autorisé). Pensez-y comme à une clé de maison : elle vous permet, à vous et à votre famille, d'entrer, mais interdit l'accès à tous les autres.

L'inclusion d'un champ d'application pour une clé d'identification privée (API ) ajoute un autre niveau d'autorisation, en limitant l'accès d'un tiers à un élément spécifique. Les champs d'application sont semblables à une clé d'hôtel, qui ne vous donne accès qu'à certaines zones (comme votre chambre ou la salle de sport) et non à l'ensemble du bâtiment. 

Types de scopes

Lorsque vous créez une clé d'API, vous devez en sélectionner le champ d'application. En d'autres termes, vous devez décider si vous souhaitez qu'une tierce personne le fasse :

• Ne pas avoir accès à un API points de terminaison.
• Visualiser toutes les données d'un site API points de terminaison, sans pouvoir y apporter de modifications (également appelé "lecture seule"). 
• Créer, supprimer et apporter d'autres modifications à tout ce qui est associé à ces points de terminaison (également appelé "accès complet" ou "accès en écriture").

Par exemple, supposons que vous souhaitiez ajouter abonné à une liste Klaviyo à partir d'un logiciel tiers. Dans ce cas, vous devez avoir un accès complet (en écriture) aux API points de terminaison pour la liste, le profil et le profil d'abonnement en bloc. Toutefois, le tiers n'a pas besoin d'accéder à d'autres points de terminaison. 

Vous pouvez en savoir plus sur l'API deKlaviyo et voir les champs d'application disponibles pour chaque point de terminaison sur le portail de développement. 

Avant de commencer

Veuillez noter ce qui suit : 

• Une fois que vous avez créé une clé d'API privée, vous ne pouvez plus l'utiliser :
  • Visualisez à nouveau la clé d'or privéeAPI. 
    • Conseil : sauvegardez en toute sécurité votre clé d'or privéeAPI et notez l'usage que vous souhaitez en faire, par exemple dans un gestionnaire de mots de passe. 
  • Ajoutez ou modifiez ses champs d'application. 
    • Si vous devez changer de portée, la seule option est de supprimer la clé d'ori gine privéeAPI et d'en créer une nouvelle avec la portée correcte. 
• Les clés d'or privées (API ) ont un accès complet par défaut.

Si vous n'êtes pas sûr des API points de terminaison, des portées ou des autorisations dont vous avez besoin, veuillez contact un développeur ou communiquer auprès d'un Klaviyo partenaire pour obtenir de l'aide. 

Créez une clé API privée 

1. Cliquez sur le nom de votre organisation en bas à gauche.
2. Naviguez jusqu'à Paramètres.
3. Cliquez sur Clés API.
   
4. Cliquez sur Créer une clé d'API privée.
5. Nommez la clé API.
6. Choisissez le champ d'application que vous souhaitez attribuer à la clé API :
   • Lecture seule
   • Complet
   • Sur mesure
     
7. Sélectionnez Créer.

Désormais, lorsque vous partagez une clé d'API privée, le tiers n'a accès qu'aux informations que vous avez définies dans le champ d'application. 

Utilisation des requêtes 

Les requêtes sont utilisées dans des scénarios avancés. Si vous n'êtes pas encore familiarisé avec les requêtes ou la manière de les utiliser, nous vous recommandons de travailler avec un développeur. 

Inclure

Notez que si vous essayez d'utiliser la requête include, vous devrez modifier le format par rapport à ce qui est indiqué ci-dessus.

Par exemple, le point de terminaison des profils est /api/profiles.

Cependant, si vous ajoutez le paramètre de requête include(/api/profiles?include=list), vous aurez également besoin d'un accès list:read ou list:full, en fonction du type d'appel à l'API que vous effectuez.

Scopes

En utilisant le paramètre scopes, vous pouvez créer un paramètre URL pour remplir automatiquement le champ d'accès dont vous avez besoin pour votre clé d'API privée. 

Dans la requête sur les champs d'application, incluez une liste séparée par des virgules des champs d'application que vous souhaitez présélectionner. 

Voici un exemple d'URL : 
https://www.klaviyo.com/create-private-api-key?scopes=campaigns:read,campaigns:write

Cloner une clé d'API privée

Avec les clés d'API privées, le clonage vous permet de créer une nouvelle clé ayant les mêmes champs d'application et autorisations que la clé d'origine.

Notez que :

• Le clonage ne génère pas la même clé que la clé privée originale de l'API.
• Vous ne pouvez pas renommer une clé API clonée ; elle porte le même nom que la clé d'origine. 

Pour cloner une clé d'API privée : 

1. Accédez à l'onglet Clés API . 
2. Cliquez sur le menu à 3 points en regard de la touche que vous souhaitez cloner. 
3. Sélectionnez Clone > Clone. 
   
4. Copiez ou téléchargez la nouvelle clé d'API et placez-la dans un endroit sûr. 
5. Veillez à supprimer vos anciennes clés qui ne sont plus utilisées. 

Ressources complémentaires

• Consultez notre article sur l'utilisation des API de Klaviyo.
• Consultez d'autres documents destinés aux développeurs.
• En savoir plus sur la sécurisation de votre compte.