Aller au contenu principal

Rechercher

Tapez un mot ou une question pour rechercher dans les articles d'aide.

Comment créer une clé API ?

Dans cet article

Emplacement : Paramètres → Avancé → Connecter d'autres applications

Ouvrez cette page : admin.<your-site>/settings/integrations (remplacez <your-site> par l'adresse de votre site). Si elle n'apparaît pas dans le menu, activez Afficher tous les paramètres sur la page Paramètres.

Avant de commencer

  • Seul le propriétaire du site peut créer des clés.

Étapes à suivre

  1. Ouvrez Paramètres → Avancé → Connecter d'autres apps → Clés API.
  2. Appuyez sur Créer une clé.
  3. Saisissez un Nom, par exemple « Site partenaire ».
  4. Sous Que peut-elle faire ?, cochez les accès nécessaires :
    • Lire les articles : articles publiés, hors contenu payant.
    • Lire tout le contenu payant : inclut également l'intégralité des articles payants.
    • Envoyer des brouillons : ajoute des articles sous forme de brouillons. Rien n'est publié sans votre équipe.
    • Envoyer des photos : ajoute des photos à votre médiathèque depuis une adresse web.
    • Lire les rubriques et tags.
    • Lire les chiffres de trafic : vues d'articles et total des visiteurs.
    • Lire les rapports financiers : totaux uniquement, jamais les données des lecteurs.
  5. Facultatif : définissez Expire le, Uniquement depuis ces adresses (une par ligne, jusqu'à 20), Requêtes par minute (de 1 à 600) et Requêtes par jour (de 1 à 1 000 000).
  6. Appuyez sur Créer une clé.
  7. Copiez la clé affichée dans l'encadré. Elle ne s'affichera plus jamais. Appuyez sur C'est noté.
  8. Transmettez la clé à l'autre application. Elle devra l'envoyer dans l'en-tête « Authorization: Bearer ».

Bon à savoir

  • La liste affiche pour chaque clé son Nom, Autorisations, Dernière utilisation, Expire le et Statut : Opérationnel, Expiré ou Arrêté.
  • Créer une nouvelle clé remplace une clé. L'ancienne continue de fonctionner pendant le délai de votre choix, ou choisissez Arrêter maintenant si elle a pu être compromise.
  • Désactiver la clé bloque immédiatement toutes les requêtes utilisant cette clé. Cette action est irréversible. Créez une nouvelle clé pour réautoriser l'application.
  • Les détails d'une clé indiquent son utilisation au cours des 30 derniers jours.
  • Chaque clé dispose de ses propres limites. Une application qui envoie trop de requêtes est ralentie.
  • Une clé donnant accès au contenu payant permet à quiconque la possède de lire les articles payés par vos abonnés. Gardez-la en lieu sûr.

Problèmes fréquents

  • « Vous avez atteint le nombre maximal de clés autorisées. Désactivez d'abord une clé que vous n'utilisez plus. »
  • « Donnez un nom à la clé. »
  • « Choisissez au moins une action autorisée pour cette clé. »
  • « Choisissez une date ultérieure. »

Questions

Foire aux questions

Puis-je revoir la clé plus tard ?

Non. Créez une nouvelle clé à la place.

Une même clé peut-elle servir pour plusieurs applications ?

C'est possible, mais donnez une clé distincte à chaque application afin de pouvoir n'en bloquer qu'une seule si besoin.

Articles connexes

Avis

Ça a été utile ?

Également disponible en

Besoin d'aide ?